Skip to content

Conversation

@JonathanWoollett-Light
Copy link
Contributor

@JonathanWoollett-Light JonathanWoollett-Light commented Jun 24, 2025

Updates the documentation for when poetry add is called without specifying a version constraints.

It was highlighted in #10444 by dimbleby that when a version constraint is not specified for poetry add it will attempt to use the latest version.

I think the current documentation does not clearlycommunicate this as poetry will choose a suitable one based on the available package versions. can mislead readers into thinking poetry itself will attempt to resolve versions to find a suitable version, when it instead will try the latest and if this fails will fail and then someone may need to manually select a version that works for them.

Pull Request Check List

Resolves: #10444

  • Added tests for changed code.
  • Updated documentation for changed code.

Summary by Sourcery

Clarify the documentation for poetry add when no version constraint is provided to indicate that Poetry will attempt to use the latest package version and add corresponding tests to cover this behavior.

Enhancements:

  • Clarify the behavior of poetry add without a version constraint in the CLI documentation.

Documentation:

  • Update the add command description to state that Poetry will attempt to use the latest version when no constraint is specified.

Tests:

  • Add tests to verify the default version resolution behavior of poetry add.

@sourcery-ai
Copy link

sourcery-ai bot commented Jun 24, 2025

Reviewer's Guide

Updates the CLI documentation to clarify that running poetry add without a version constraint defaults to installing the latest available package version rather than resolving a suitable version.

File-Level Changes

Change Details Files
Clarify behavior of poetry add when no version is specified
  • Removed wording suggesting Poetry resolves a suitable version
  • Replaced with explicit note that Poetry attempts to use the latest version
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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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


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.

Updates the documentation for when `poetry add` is called without specifying a version constraints.
@radoering radoering added the impact/docs Contains or requires documentation changes label Jun 28, 2025
@github-actions
Copy link

Deploy preview for website ready!

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

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

@radoering radoering merged commit 8c07068 into python-poetry:main Jun 28, 2025
56 checks passed
@github-actions
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 Jul 29, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

impact/docs Contains or requires documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Error handling llmvlite transitive dependency

2 participants