Skip to content

Fix inconsistency in dependency resolution documentation #10751

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

Merged
merged 3 commits into from
Apr 22, 2024

Conversation

wiggin15
Copy link

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 and package_water) to "real" package names (pytest and pytest-cov). While the new example may be a little more understandable, this caused some inconsistencies and "bugs" in the documentation, namely:

  • The wording .. 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.
  • There is a missing word in the newer documentation: with a version or equal to
  • Most importantly, later in the documentation the "dummy" package names are mentioned again (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).

@wiggin15
Copy link
Author

I don't think this change requires a news entry (?). Can I make it skip the check?

@pradyunsg
Copy link
Member

Yup. Add a news/10751.trivial file to do that. :)

@wiggin15
Copy link
Author

Done.

@pradyunsg I just noticed the only other branch that pip has other than main deals with something in the same area: branch revert-10279-reorg-dependency-resolution-information commit e30bfac . Do you remember if the reason for reverting the doc reorg had something to do with this issue?

@DiddiLeija
Copy link
Member

I just noticed the only other branch that pip has other than main deals with something in the same area: branch revert-10279-reorg-dependency-resolution-information commit e30bfac . Do you remember if the reason for reverting the doc reorg had something to do with this issue?

That branch belongs to #10660. Quoting from @pradyunsg's comment:

The branch name suggests that this reverts #10279.

However, it is not immediately clear what this PR does, so I'm gonna go ahead and close this out eagerly.

We don't what was the branch for. You can just ignore it.

@ichard26 ichard26 self-requested a review April 22, 2024 16:06
@ichard26 ichard26 added the skip news Does not need a NEWS file entry (eg: trivial changes) label Apr 22, 2024
@ichard26
Copy link
Member

ichard26 commented Apr 22, 2024

It's probably worth merging in main just to trigger the docs build and ensure it's still green, but a local build did seem to work (after merging in main manually).

@pfmoore pfmoore merged commit 46a342b into pypa:main Apr 22, 2024
12 checks passed
@ichard26
Copy link
Member

Thanks @wiggin15 for the PR! (and apologies for taking so long to getting it merged)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants