Skip to content

Fix basic usage docs example about environment activation#9986

Merged
finswimmer merged 1 commit intopython-poetry:mainfrom
LeoTheGriff:docs/patch-basic-usage-command-ref
Jan 7, 2025
Merged

Fix basic usage docs example about environment activation#9986
finswimmer merged 1 commit intopython-poetry:mainfrom
LeoTheGriff:docs/patch-basic-usage-command-ref

Conversation

@LeoTheGriff
Copy link
Copy Markdown
Contributor

@LeoTheGriff LeoTheGriff commented Jan 7, 2025

Documentation:

Very minor change deprecating poetry shell in an example in 'Basic Usage' docs; loosely relates to change #9963.

Summary by Sourcery

Documentation:

  • Clarify the recommended way to activate a project environment in the basic usage documentation.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This PR deprecates the use of poetry shell in the basic usage documentation, replacing it with poetry env activate. This change aligns the documentation with the updated command for activating the project's virtual environment.

Sequence diagram for environment activation commands

sequenceDiagram
    participant User as Developer
    participant Poetry as Poetry CLI
    participant VEnv as Virtual Environment

    Note over User, VEnv: Old workflow
    User->>Poetry: poetry shell
    Poetry-->>VEnv: Activate environment (Deprecated)
    VEnv-->>User: Shell with activated environment

    Note over User, VEnv: New workflow
    User->>Poetry: poetry env activate
    Poetry-->>VEnv: Activate environment
    VEnv-->>User: Shell with activated environment
Loading

File-Level Changes

Change Details Files
Replaced poetry shell with poetry env activate in the example demonstrating how to activate the project's virtual environment.
  • Replaced the command poetry shell with poetry env activate.
  • Updated the example to reflect the preferred way of activating the Poetry environment.
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
Copy Markdown

@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 @LeoTheGriff - I've reviewed your changes and they look great!

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.

@finswimmer finswimmer merged commit 3f0add5 into python-poetry:main Jan 7, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 7, 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.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Feb 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants