-
Notifications
You must be signed in to change notification settings - Fork 3k
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: Description of "--upgrade-strategy=only-if-needed" seems inconsistent? #8726
Comments
Both docs are correct, but the wording is a bit confusing. |
Gotcha. So one way to solve is mention in the user-facing docs what happens when However, I feel that it doesn't cover the fact that the |
Both Here’s a run down of the differences. Say you have
The user documentation says |
Ah, gotcha. I read "direct requirements" as "direct dependency of requirements", as you've pointed out. So then a better solution (to help lazy people like me :P) would be to use the same wording in both places (if possible), and possibly copy the explanation from dev docs to the user docs, possibly with your example in tow. Will take a whack at it. |
The difficult part would to figure out what the best wording is. Packages probably won’t work in the |
Environment
N/A
Description
See doc permalinks (through GitHub, I dunno how to permalink the
pypa.io
stuff):Non-permlinks:
In the "user-guide" section,
--upgrade-strategy=only-if-needed
is described as upgrading only if the existing package does not meet given requirements. However, in the "architecture" section,--upgrade-strategy=to-satisfy-only
seems to cover this, whileonly-if-needed
seems to now upgrade iff the package is a direct dependency.Expected behavior
The docs match? Or, at least if
to-satisfy-only
is to remain hidden away, at least the behavior ofonly-if-needed
is reconciled?How to Reproduce
See citations above.
Output
N/A
\cc @thduynguyen
The text was updated successfully, but these errors were encountered: