Thanks to visit codestin.com
Credit goes to github.com

Skip to content

✏ Fix typo in docs about contributing, for compatibility with pip in Zsh#5523

Merged
tiangolo merged 3 commits into
fastapi:masterfrom
zhangbo2012:master
Oct 31, 2022
Merged

✏ Fix typo in docs about contributing, for compatibility with pip in Zsh#5523
tiangolo merged 3 commits into
fastapi:masterfrom
zhangbo2012:master

Conversation

@zhangbo2012

@zhangbo2012 zhangbo2012 commented Oct 20, 2022

Copy link
Copy Markdown
Contributor

with zsh, use command python -m pip install -e .[dev,doc,test] not working

(venv) zhangbo@zhangbodeMacBook-Pro fastapi % python -m pip install -e .[dev,doc,test]      
zsh: no matches found: .[dev,doc,test]
(venv) zhangbo@zhangbodeMacBook-Pro fastapi % pip -V
pip 22.3 from /Users/zhangbo/PycharmProjects/fastapi/venv/lib/python3.10/site-packages/pip (python 3.10)

Update to python -m pip install -e ."[dev,doc,test]" , It worked

@codecov

codecov Bot commented Oct 20, 2022 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (4d9d05a) compared to base (bbb8fe1).
Patch has no changes to coverable lines.

Additional details and impacted files 
@@            Coverage Diff            @@
##            master     #5523   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          540       540           
  Lines        13946     13946           
=========================================
  Hits         13946     13946

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@github-actions

github-actions Bot commented Oct 20, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 754fe3f at: https://6350e7f6d471d66daba0e771--fastapi.netlify.app

JarroVGIT
JarroVGIT approved these changes Oct 20, 2022
View reviewed changes

@JarroVGIT JarroVGIT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have tested the change on bash as well, and it still works. So, this change makes it work on both bash ans zsh, while previously it would only work on bash. I'd recommend to merge this change in the docs. It was originally missed by PR #3131 which was merged (as later on, FastAPI moved away from Flit).

@github-actions

github-actions Bot commented Oct 28, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 6d5d9d3 at: https://635b2b484f301710a309ae07--fastapi.netlify.app

@tiangolo tiangolo changed the title update contributing.md, pip install environment do not work with zsh ✏ Fix typo in docs about contributing, for compatibility with pip in Zsh Oct 31, 2022
@tiangolo

tiangolo commented Oct 31, 2022

Copy link
Copy Markdown
Member

Awesome, good catch, thanks for the contribution @zhangbo2012! 🍰

And thanks for the reviews everyone, in particular @JarroVGIT, the comments telling me exactly what you tested and checked, help me a lot and help me see that you did review it. 🤓

@tiangolo tiangolo enabled auto-merge (squash) October 31, 2022 16:44
@tiangolo tiangolo merged commit 22524a1 into fastapi:master Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers

@iudeen iudeen iudeen approved these changes

@JarroVGIT JarroVGIT JarroVGIT approved these changes

@yezz123 yezz123 yezz123 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

hacktoberfest-accepted

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@zhangbo2012 @tiangolo @iudeen @JarroVGIT @yezz123