Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error in the setup docs for black. #4412

Closed
Mr-Sunglasses opened this issue Jul 25, 2024 · 4 comments · Fixed by #4413
Closed

Error in the setup docs for black. #4412

Mr-Sunglasses opened this issue Jul 25, 2024 · 4 comments · Fixed by #4413
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@Mr-Sunglasses
Copy link
Contributor

Is this related to a problem? Please describe.

Error in the Setup docs command pip install -e .[d], here [d] has no significance which causes an error while installing.

(.venv) kanishkpachauri in ~/Desktop/oss/Python/black on main λ pip install -e .[d]
zsh: no matches found: .[d]
Screenshot 2024-07-25 at 8 16 59 AM

Describe the solution you'd like

Remove [d] from the docs.

Describe alternatives you've considered

Additional context

@Mr-Sunglasses Mr-Sunglasses added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Jul 25, 2024
@JelleZijlstra
Copy link
Collaborator

.[d] here installs the extra for blackd. Depending on your shell you may need to do pip install -e '.[d]' instead.

@Mr-Sunglasses
Copy link
Contributor Author

.[d] here installs the extra for blackd. Depending on your shell you may need to do pip install -e '.[d]' instead.

Thanks, @JelleZijlstra, it worked, I'm currently using the zsh shell, does '.[d]' a safe option and work on every shell, yes then we can add it into the docs so that I can't cause the error for other users.

@JelleZijlstra
Copy link
Collaborator

I think it should work on any Unix shell but not sure about the required quoting on Windows.

@Mr-Sunglasses
Copy link
Contributor Author

Mr-Sunglasses commented Jul 25, 2024

I think it should work on any Unix shell but not sure about the required quoting on Windows.

@JelleZijlstra , I've tested both Windows and UNIX systems, and `".[d]" works for both systems.

Test on windows: Action ref

Screenshot 2024-07-25 at 8 55 47 AM

Test on Unix: ( tested on macOS 14.5 )

Screenshot 2024-07-25 at 8 58 28 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants