doc(cli): add missing docs for env command#10027
Merged
abn merged 1 commit intopython-poetry:mainfrom Jan 13, 2025
Merged
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
|
abn
added
area/docs
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
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! Built with commit 248e94b. |
abn
force-pushed
the
docs/cli-env
branch
2 times, most recently
from
b47d938 to
798cb49
Compare
Secrus
reviewed
Jan 13, 2025
Secrus
approved these changes
Jan 13, 2025
|
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This helps mitigate issues like #10024.
Summary by Sourcery
Documentation:
env activate,env info,env list,env remove, andenv usecommands.