Skip to content

docs: quote optional dependency install examples#2062

Draft
nyxst4ck wants to merge 1 commit into
microsoft:mainfrom
nyxst4ck:nyxst4ck/docs-first-pass
Draft

docs: quote optional dependency install examples#2062
nyxst4ck wants to merge 1 commit into
microsoft:mainfrom
nyxst4ck:nyxst4ck/docs-first-pass

Conversation

@nyxst4ck

@nyxst4ck nyxst4ck commented Jun 3, 2026

Copy link
Copy Markdown

Quotes optional dependency install examples so shells do not expand package extras, and fixes a small MarkItDown typo in an audio dependency message.

@nyxst4ck

nyxst4ck commented Jun 3, 2026

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

@noezhiya-dot noezhiya-dot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small but important docs fix. Without quotes, shells like zsh expand markitdown[all] as a glob pattern (trying to match files in the current directory), which either fails silently or installs the wrong thing. Quoting is the standard practice for pip install examples.

The typo fix in the audio dependency message is a nice bonus. LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants