Fix inconsistency in dependency resolution documentation #10751
Merged
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.
It looks like during commit d7c33065ad, the example given for "dependency resolution" in the docs was changed from using "dummy" package names (
package_coffee
,package_tea
andpackage_water
) to "real" package names (pytest
andpytest-cov
). While the new example may be a little more understandable, this caused some inconsistencies and "bugs" in the documentation, namely:.. pip cannot install the packages requested because they are asking for conflicting versions of pytest
is not entirely accurate - these are not two different packages asking for pytest, but one package asking for pytest and pytest itself.with a version or equal to
In our first example both `package_coffee` and `package_tea` ...
), and since this is the only place they were mentioned before this part, the docs are now inconsistent and confusing.I reverted the example to use the older package names. I also switched the "dummy" versions a bit, because in one place it said
package_tea 4.3.0 depends on package_water==2.3.1
and then later it said`package_tea 4.1.3` which also depends on `package_water 2.6.1`
which makes less sense (older version using a newer version of a dependency).