docs: update unspecified version docs for add#10445
Merged
radoering merged 1 commit intopython-poetry:mainfrom Jun 28, 2025
Merged
docs: update unspecified version docs for add#10445radoering merged 1 commit intopython-poetry:mainfrom
add#10445radoering merged 1 commit intopython-poetry:mainfrom
Conversation
Reviewer's GuideUpdates the CLI documentation to clarify that running File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @JonathanWoollett-Light - I've reviewed your changes and they look great!
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.
3019e04 to
0f6f056
Compare
|
Deploy preview for website ready! Built with commit 0f6f056. |
radoering
approved these changes
Jun 28, 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the documentation for when
poetry addis called without specifying a version constraints.It was highlighted in #10444 by dimbleby that when a version constraint is not specified for
poetry addit 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
Summary by Sourcery
Clarify the documentation for
poetry addwhen 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:
poetry addwithout a version constraint in the CLI documentation.Documentation:
addcommand description to state that Poetry will attempt to use the latest version when no constraint is specified.Tests:
poetry add.