Repository navigation
docs: quote pip extras so zsh does not glob them - #171
Conversation
Unquoted `questdb[dataframe]` fails under zsh (the macOS default shell) with "no matches found" before pip runs.
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
Quote package specifications README.rst, docs/installation.rst |
The README command and the pip and Poetry examples now quote package specifications that include extras. |
Priority:
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other
Suggested reviewers: mtopolnik
Merge Risk: 
Minimal · up to 32ae0
-
No actionable merge-blocking risk was identified.
Pre-merge checks: 
5
-
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
python3 -m pip install -U questdb[dataframe], the first command in the README and on RTD, fails under zsh (the macOS default shell):zsh treats
[...]as a glob, so pip never runs. This PR quotes the extras inREADME.rstanddocs/installation.rst(both pip and poetry). The old CHANGELOG entries are left as they are.I checked it with zsh 5.9: the unquoted command fails and the quoted one installs.
Note that RTD
/stablebuilds from the release tag, so the fix shows up there only after the next release.Summary by CodeRabbit