-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
doc(cli): add missing docs for env command #10027
Conversation
Reviewer's Guide by SourceryThis PR adds documentation for the Flow diagram for Poetry env command optionsgraph LR
env[Poetry env]
activate[env activate]
info[env info]
list[env list]
remove[env remove]
use[env use]
env --> activate
env --> info
env --> list
env --> remove
env --> use
activate -->|Prints| activation[Activation Command]
info -->|Shows| current[Current Environment Info]
list -->|Shows| virtualenvs[Project Virtualenvs]
remove -->|Deletes| virtualenv[Virtual Environment]
use -->|Activates/Creates| newenv[New Virtual Environment]
style env fill:#f9f,stroke:#333
style activation fill:#dfd
style current fill:#dfd
style virtualenvs fill:#dfd
style virtualenv fill:#dfd
style newenv fill:#dfd
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @abn - I've reviewed your changes - here's some feedback:
Overall Comments:
- There are a couple of minor text issues to fix:
- In the 'activate' section: "on you can" should be "on how you can"
- In the 'use' section: "a new a virtualenv" should be "a new virtualenv"
Here's what I looked at during the review
- 🟡 General issues: 4 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Deploy preview for website ready! ✅ Preview Built with commit 248e94b. |
b47d938
to
798cb49
Compare
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This helps mitigate issues like #10024.
Summary by Sourcery
Documentation:
env activate
,env info
,env list
,env remove
, andenv use
commands.