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

[Docs] dependency_links removal documentation #4859

Open
1 task done
plocket opened this issue Feb 27, 2025 · 1 comment
Open
1 task done

[Docs] dependency_links removal documentation #4859

plocket opened this issue Feb 27, 2025 · 1 comment
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.

Comments

@plocket
Copy link

plocket commented Feb 27, 2025

Summary

Thank you for your work on this package. I'll admit I'm pretty new to the python ecosystem, so I apologize if I'm off base here.

I was reading the steuptools documentation of dependency_links of the latest version. At the top, it has a warning that "Dependency links support has been dropped by pip starting with version 19.0 (released 2019-01-22)." I was confused about what to do next, since I needed to specify a link to a GitHub repo. I would have found it useful if there were a link to the current documentation on how to achieve the same result with current versions of pip.

I found this link that had a bit more up to date information: https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#direct-url-dependencies. It doesn't line up with what I found at https://packaging.python.org/en/latest/specifications/dependency-specifiers/#examples, though, which uses a zip address. I'm not sure what the best edit would be.

By the way, the issue template here says there's a "View on GitHub" link on every documentation page, but I was unable to find that on pages on the documentation site.

OS / Environment

Irrelevant.

Additional Information

I think adding to these docs can help developers understand how to solve a problem with less digging and be more up to date with the specs.

Code of Conduct

  • I agree to follow the PSF Code of Conduct
@plocket plocket added documentation Needs Triage Issues that need to be evaluated for severity and status. labels Feb 27, 2025
@abravalheri
Copy link
Contributor

Hi @plocket, thanks for the feedback.
I am not sure if the docs used to have the button and somehow the template changed or not, but I just enabled the edit on github button to show up in the docs (there is a pencil icon on the top right corner of the page now). The eye icon should also show things in GitHub now.

https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#direct-url-dependencies. It doesn't line up with what I found at https://packaging.python.org/en/latest/specifications/dependency-specifiers/#examples

Could you please specify how they don't line up? (zip is only of of the possible formats accepted).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Needs Triage Issues that need to be evaluated for severity and status.
Projects
None yet
Development

No branches or pull requests

2 participants