-
Notifications
You must be signed in to change notification settings - Fork 2.4k
docs: update unspecified version docs for add
#10445
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
docs: update unspecified version docs for add
#10445
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.
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!
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! ✅ Preview Built with commit 0f6f056. |
|
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. |
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.