Skip to content

docs: quote pip extras install examples - #625

Closed
nyxst4ck wants to merge 1 commit into
tirth8205:mainfrom
nyxst4ck:nyxst4ck/auto-quote-pip-extras-20260717-090741
Closed

docs: quote pip extras install examples#625
nyxst4ck wants to merge 1 commit into
tirth8205:mainfrom
nyxst4ck:nyxst4ck/auto-quote-pip-extras-20260717-090741

Conversation

@nyxst4ck

Copy link
Copy Markdown
Contributor

Summary

  • Quote pip install examples that include extras.

Why

  • Shells such as zsh can expand unquoted bracket expressions before pip receives them.

Scope

  • Files changed:
  • README.hi-IN.md
  • README.ja-JP.md
  • README.ko-KR.md
  • README.md
  • README.zh-CN.md
  • This does not change dependencies or runtime behavior.

Testing

  • git diff --check

Maintainer Fit

  • Small install-command correctness fix.
  • Duplicate PR search terms checked: quote pip extras, quote optional dependency, zsh pip install extras, pip extras install examples

Bakul2006 pushed a commit to Bakul2006/code-review-graph that referenced this pull request Jul 17, 2026
Carry PR tirth8205#625's zsh fix through all current user docs, using double quotes
instead of single quotes so the examples also work in Windows cmd.exe. Add
a regression that prevents unquoted extras from returning.

Co-Authored-By: nyxst4ck <289980115+nyxst4ck@users.noreply.github.com>
@tirth8205

Copy link
Copy Markdown
Owner

Merged the cross-shell documentation correction through maintainer PR #627 (merge commit ceb6fba) with @nyxst4ck's authorship credited in commit cfd53eb.

The final port uses double quotes, which preserve the JSON on zsh/bash and also work in Windows cmd.exe; the original single-quote form would fail on cmd.exe. It updates all localized READMEs and current command/FAQ/reference/troubleshooting docs, with a regression test. Full CI is green. Closing this source PR as incorporated.

@tirth8205 tirth8205 closed this Jul 17, 2026
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