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

Fix basic usage docs about environment activation #9963

Merged
merged 2 commits into from
Jan 6, 2025

Conversation

Secrus
Copy link
Member

@Secrus Secrus commented Jan 6, 2025

Summary by Sourcery

Documentation:

  • Updated the basic usage documentation to remove the outdated section about activating virtual environments and instead point to the relevant section in "Managing Environments".

Copy link

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This 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

Change Details Files
Removed the section on activating virtual environments using poetry shell or manual activation.
  • Removed instructions and explanations related to poetry shell, exit, deactivate, and manual virtual environment activation.
  • Removed the table summarizing the different activation methods.
  • Replaced the removed content with a reference to the "Activating the virtual environment" section in the "Managing Environments" documentation.
  • Updated the note about not needing poetry shell when managing external virtual environments to remove the reference to poetry shell since it is no longer relevant given the other changes in this PR.
docs/basic-usage.md
Updated the note about using poetry run.
  • Removed the reference to poetry shell in the note explaining when to use poetry run.
  • Clarified that poetry run is not needed when using an externally managed virtual environment that is already activated.
docs/basic-usage.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@radoering radoering added the impact/docs Contains or requires documentation changes label Jan 6, 2025
docs/basic-usage.md Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Jan 6, 2025

Deploy preview for website ready!

✅ Preview
https://website-i590pdj86-python-poetry.vercel.app

Built with commit c4d0512.
This pull request is being automatically deployed with vercel-action

@Secrus Secrus requested a review from radoering January 6, 2025 17:39
docs/basic-usage.md Outdated Show resolved Hide resolved
@radoering
Copy link
Member

Still in question: The linked section does not mention how to deactivate the environment. Should we keep this information somewhere?

@Secrus
Copy link
Member Author

Secrus commented Jan 6, 2025

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.

@Secrus Secrus enabled auto-merge (squash) January 6, 2025 20:39
@Secrus Secrus merged commit 3bb8d63 into python-poetry:main Jan 6, 2025
74 checks passed
@Secrus Secrus deleted the fix-docs branch January 6, 2025 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants