docs: Use double quotes for pip extras so install commands work in cmd.exe#2242
Open
LHMQ878 wants to merge 1 commit into
Open
docs: Use double quotes for pip extras so install commands work in cmd.exe#2242LHMQ878 wants to merge 1 commit into
cmd.exe#2242LHMQ878 wants to merge 1 commit into
Conversation
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2232
Problem
The install commands in the READMEs single-quote the extras, e.g.
pip install -e 'packages/markitdown[all]'.cmd.exedoes not strip single quotes, so pip receivesthem as part of the path and rejects it:
Change
Switched the six
pip installsnippets inREADME.mdandpackages/markitdown/README.mdfrom single to double quotes.
Double quotes rather than dropping the quotes entirely, because the quoting is still needed on
POSIX shells -
[all]is a character-class glob pattern in bash/zsh, so an unquotedmarkitdown[all]can be word-expanded if a matching path happens to exist. Double quotes arethe one form that works in
cmd.exe, PowerShell, bash and zsh alike.Verification
Windows 11, Python 3.12, pip 26.1.2. Using
--dry-run --no-depsso nothing is actuallyinstalled:
pip install -e 'packages/markitdown[all]'(before)pip install -e "packages/markitdown[all]"(after)Note that this only reproduces under
cmd.exe. PowerShell strips single quotes itself, whichis probably why it has gone unnoticed.
After the change:
invalid editable requirementerrors: 0.The reporter suggested removing the quotes; double-quoting keeps the POSIX side safe as well,
but happy to switch to unquoted if you prefer that for consistency with other docs.