Skip to content

docs: quote pip extras so zsh does not glob them - #171

Merged
jerrinot merged 1 commit into
mainfrom
docs/quote-pip-extras
Oct 30, 2026
Merged

jerrinot merged 1 commit into
mainfrom
docs/quote-pip-extras

Conversation

@jerrinot

@jerrinot jerrinot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

python3 -m pip install -U questdb[dataframe], the first command in the README and on RTD, fails under zsh (the macOS default shell):

zsh: no matches found: questdb[dataframe]

zsh treats [...] as a glob, so pip never runs. This PR quotes the extras in README.rst and docs/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 /stable builds from the release tag, so the fix shows up there only after the next release.

Summary by CodeRabbit

  • Documentation
    • Updated installation examples to quote package specifications with extras for pip and Poetry, including dataframe, polars, and duckdb.

Unquoted `questdb[dataframe]` fails under zsh (the macOS default
shell) with "no matches found" before pip runs.
@jerrinot
jerrinot requested a review from a team as a code owner October 30, 2026 14:49
@coderabbitai

coderabbitai Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: edf2755f-7887-4154-8454-86e180697db0
Commits

Reviewing files that changed from the base of the PR and between b918a42 and 32ae034.

Files selected for processing: 2
  • README.rst
  • docs/installation.rst

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

Installation commands in the README and installation guide now quote package specifications that include extras such as dataframe, polars, and duckdb.

Changes: Installation command quoting

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: Low

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: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main documentation change: quoting pip extras to prevent zsh glob expansion.
Docstring Coverage Passed 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. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@jerrinot
jerrinot merged commit 8190c2a into main Oct 30, 2026
30 checks passed
@jerrinot
jerrinot deleted the docs/quote-pip-extras branch October 30, 2026 16:24
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