Skip to content
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

Documentation inconsistency in #DependencyResolution chapter #12583

Open
1 task done
Stamp9 opened this issue Mar 21, 2024 · 1 comment
Open
1 task done

Documentation inconsistency in #DependencyResolution chapter #12583

Stamp9 opened this issue Mar 21, 2024 · 1 comment
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related

Comments

@Stamp9
Copy link

Stamp9 commented Mar 21, 2024

Description

In the v24.0 doc, in Dealing with conflicts section, the error message example is about python -m pip install "pytest < 4.6" pytest-cov==2.12.1 while the explanation also mentions package_tea version 4.3.0 depends on version 2.3.1 of package_water.
Then in the Loosen your top level requirements, it says "In our first example both package_coffee and package_tea have been pinned to use specific versions (package_coffee==0.44.1b0 package_tea==4.3.0)." actually there is no example about coffee & tea. It is a bit confusing.

Expected behavior

Maybe change(or add) the error message example in #Understanding your error messageor change the example used in #loosen-your-top-level-requirements

pip version

doc v24.0

Python version

OS

How to Reproduce

Go to https://pip.pypa.io/en/stable/topics/dependency-resolution/#

Output

No response

Code of Conduct

@Stamp9 Stamp9 added S: needs triage Issues/PRs that need to be triaged type: bug A confirmed bug or unintended behavior labels Mar 21, 2024
@uranusjr uranusjr added type: docs Documentation related good first issue A good item for first time contributors to work on and removed type: bug A confirmed bug or unintended behavior S: needs triage Issues/PRs that need to be triaged labels Mar 26, 2024
@Keyuan125
Copy link

I'm happy to work on this! I think there are at least two mistakes that may need correction:

  1. The error example is missing in the #Understanding your error message section. I think it should be python -m pip install package_coffee==0.44.1b0 package_tea==4.3.0, based on the discussion in Loosen your top level requirements

  2. In Loosen your top level requirements, there seems to be a discrepancy with two statements regarding package dependencies:

    package_coffee 0.46.0b0, which depends on package_water 2.6.1
    package_tea 4.3.0 which also depends on package_water 2.6.1

    package_coffee 0.44.1b0, which depends on package_water 2.6.1
    package_tea 4.1.3 which also depends on package_water 2.6.1

Besides, these packages seems to be fabricated examples intended to illustrate the concept. Should I continue using these hypothetical names, or would it be more beneficial to employ real package names to enable readers to replicate the issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good item for first time contributors to work on type: docs Documentation related
Projects
None yet
Development

No branches or pull requests

3 participants