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

📝 Update docs with pip install calls when using extras with brackets, use quotes for compatibility with Zsh #3131

Merged
merged 5 commits into from
Oct 7, 2021

Conversation

tomwei7
Copy link
Contributor

@tomwei7 tomwei7 commented Apr 25, 2021

Square brackets in zsh have special meanings. Copy and run pip install uvicorn[standard] in zsh will get error.

@Kludex
Copy link
Member

Kludex commented Apr 25, 2021

It will not.

@waynerv
Copy link
Contributor

waynerv commented Apr 26, 2021

I had this problem before and now I finally know how to solve it.zsh uses square brackets for globbing / pattern matching.

I've never seen it (add quotation mark) in any other documentation, but add a notice about this problem should be nice.

@tomwei7
Copy link
Contributor Author

tomwei7 commented Apr 26, 2021

@waynerv python-language-server add quotation mark on install command pip install 'python-language-server[yapf]' in its documentation

@Kludex
Copy link
Member

Kludex commented Apr 26, 2021

Just adding the quotes as @tomwei7 suggested seems fine.

Why I don't have this problem here tho? 😅

@tomwei7
Copy link
Contributor Author

tomwei7 commented Apr 26, 2021

run zsh -f start zsh without any config that can reproduce the problem. setopt nonomatch in zsh will avoid this problem.

Copy link
Member

@Kludex Kludex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see... Ok. :)

@github-actions
Copy link
Contributor

📝 Docs preview for commit 69bd84dd7fc7f5ba091f99505ee1cf0aa02d9c87 at: https://60a23ab30a1ff163fafcd679--fastapi.netlify.app

@tiangolo tiangolo changed the title Better uvicorn install command 📝 Update docs with pip install calls when using extras with brackets, use quotes for compatibility with Zsh Oct 7, 2021
@tiangolo
Copy link
Member

tiangolo commented Oct 7, 2021

Thanks @tomwei7! 🍰

I updated it to include all the other calls of pip install that were using packages with extras.

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.

4 participants