-
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
Fix basic usage docs about environment activation #9963
Conversation
Reviewer's Guide by SourceryThis PR updates the documentation for activating virtual environments by removing outdated information and pointing to the dedicated "Managing Environments" section. No diagrams generated as the changes look simple and do not need a visual representation. 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 @Secrus - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider updating the note about external virtual environments to be consistent with the rest of the changes - it still implies different behavior for 'poetry run' vs 'poetry shell' while the latter command's documentation has been moved.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 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 c4d0512. |
Still in question: The linked section does not mention how to deactivate the environment. Should we keep this information somewhere? |
I am going to assume that someone who knows that they want to activate the environment, will know how to deactivate it. I would leave it as it is, we can add it later if we find that it is needed. |
Summary by Sourcery
Documentation: