docs: quote Python extras installs under zsh (#1222) - #1568
Merged
Merged
Conversation
inureyes
added
status:done
Keep the Python README examples in Ruff's preferred fenced-code layout so the Python workflow's format check passes. The extras-quoting fix changed only documentation, but the aligned inline comments in the fenced Python example still drifted from Ruff's formatter output. Normalize those comment columns and keep the install-command fix intact. Validation: `python -m ruff check python`, `python -m ruff format --check python`, `python -m mypy python/src`, and `python -m pytest python/tests -m "not e2e" -q`.
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
1 participant
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.
Summary
Quote the Python extras install commands so the documented
pip install ./python[dev]examples work in zsh as well as other shells.What changed
python/README.md.python/README.md's test section.docs/python-client.md.Test plan
rg -n 'pip install (\.\/python\[dev\]|-e \.\/python\[dev\])' python/README.md docs/python-client.mdreturns no matches.rg -n 'pip install ("\./python\[dev\]"|-e "\./python\[dev\]")' python/README.md docs/python-client.mdfinds all three documented commands.Closes #1222