docs: Describe --upgrade-strategy and direct requirements explicitly #8739
Conversation
|
@uranusjr Here's a low-effort attempt to render our convo as a PR. I settled on "direct/indirect requirements", with some inline explanation, as those seemed like existing terms of art. |
|
|
||
| This will only update ``SomePackage`` as it is a direct requirement. Any | ||
| of its dependencies (indirect requirements) will be affected by the | ||
| ``--upgrade-strategy`` command. |
There was a problem hiding this comment.
Indirect requirements can still be upgraded here if a later version of SomePackage needs them upgraded. Say
SomePackage==1.0needsDepPackage==1.0SomePackage==2.0needsDepPackage==2.0
With SomePackage==1.0 and DepPackage==1.0 initially installed, pip install --upgrade SomePackage will still upgrade DepPackage.
There was a problem hiding this comment.
IOW, only SomePackage is guarenteed to be upgraded. Its dependencies are upgraded only if needed.
|
Hello! I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the |
|
Closing as this is significantly out of date, and has merge conflicts. Please do feel free to resubmit an updated PR for this! ^>^ Thanks @EricCousineau-TRI for the PR! :) |
|
Sorry! Saw something shiny a few months back 😬 Filed #9692 as redux. |
Add a brief example
Resolves #8726