docs: add pip instructions when using zsh#122
Open
qlrd wants to merge 1 commit into
Open
Conversation
`pip install -e .[dev]` works fine in `sh/bash` and (which is what `README.md` assume). In zsh, unquoted `[...]` could be interpreted as a glob pattern, so zsh tries to expand .[dev] as a filename match and errors before pip ever runs. This commit add an instruction for `zsh` with `pip install -e ".[dev]"` on `README.md`.
There was a problem hiding this comment.
Pull request overview
This PR updates the development installation instructions in README.md to account for zsh glob expansion behavior, where unquoted .[dev] can be treated as a glob and fail before pip runs.
Changes:
- Add a
zsh-compatible editable install command using quotes around.[dev]. - Clarify the existing command as applicable to
sh/bash-based environments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
odudex
approved these changes
May 12, 2026
Contributor
Author
|
Duplicates #82, better close this one |
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.
pip install -e .[dev]works fine insh/bashand (which is whatREADME.mdassume). In zsh, unquoted[...]could be interpreted as a glob pattern, so zsh tries to expand .[dev] as a filename match and errors before pip ever runs. This commit add an instruction forzshwithpip install -e ".[dev]"onREADME.md.