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

doc(cli): add missing docs for env command #10027

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Conversation

abn
Copy link
Member

@abn abn commented Jan 13, 2025

This helps mitigate issues like #10024.

Summary by Sourcery

Documentation:

  • Add documentation for the env activate, env info, env list, env remove, and env use commands.

@abn abn requested a review from a team January 13, 2025 03:29
Copy link

sourcery-ai bot commented Jan 13, 2025

Reviewer's Guide by Sourcery

This PR adds documentation for the env command in the CLI. It includes details on how to activate, get information about, list, remove, and use virtual environments.

Flow diagram for Poetry env command options

graph 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
Loading

File-Level Changes

Change Details Files
Added documentation for the env activate, env info, env list, env remove, and env use commands.
  • Documented the purpose of each command.
  • Included a note about env activate clarifying that it prints the activation command, but doesn't actually activate the environment.
  • Added a section on arguments for env use, specifying the python argument.
  • Added cross-references to the "Managing environments" section for more context and details.
docs/cli.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

@abn abn added area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes labels Jan 13, 2025
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 @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

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.

docs/cli.md Outdated Show resolved Hide resolved
docs/cli.md Outdated Show resolved Hide resolved
docs/cli.md Outdated Show resolved Hide resolved
docs/cli.md Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Jan 13, 2025

Deploy preview for website ready!

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

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

@abn abn force-pushed the docs/cli-env branch 2 times, most recently from b47d938 to 798cb49 Compare January 13, 2025 03:48
docs/cli.md Outdated Show resolved Hide resolved
@abn abn requested review from Secrus and radoering January 13, 2025 13:06
@abn abn enabled auto-merge (rebase) January 13, 2025 13:06
@abn abn merged commit 88b2bab into python-poetry:main Jan 13, 2025
74 checks passed
@abn abn deleted the docs/cli-env branch January 13, 2025 16:21
@radoering radoering mentioned this pull request Feb 9, 2025
4 tasks
Copy link

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 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants