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

--extra-index-url option documentation should have warning about "dependency confusion" #11694

Open
1 task done
Marcono1234 opened this issue Jan 3, 2023 · 3 comments
Open
1 task done
Labels
type: docs Documentation related

Comments

@Marcono1234
Copy link

Marcono1234 commented Jan 3, 2023

What's the problem this feature will solve?

Currently the documentation for the --extra-index-url option does not warn about "dependency confusion", only the corresponding example contains a warning (added by #9647).

However, it is likely that users will miss that warning because they might not look at the examples section.

Describe the solution you'd like

In addition to the existing warning on the example, the documentation for the --extra-index-url option itself should also have a warning because that is most likely where users would first look for such a warning.

Alternative Solutions

-

Additional context

Not sure how easy it would be to implement this since the documentation for the options (including --extra-index-url) seems to be generated dynamically and might not support an RST warning box. Though at the very least a plaintext warning would be helpful as well. I assume in that case the warning would also be shown in the command line help, which would be useful too.

Code of Conduct

@Marcono1234 Marcono1234 added S: needs triage Issues/PRs that need to be triaged type: feature request Request for a new feature labels Jan 3, 2023
@pfmoore
Copy link
Member

pfmoore commented Jan 3, 2023

A PR with proposed wording would be welcome.

@pradyunsg pradyunsg added type: docs Documentation related and removed type: feature request Request for a new feature S: needs triage Issues/PRs that need to be triaged labels Jan 3, 2023
@Kaushik-Iyer
Copy link

Should I try to work on this? Do we just need to change documentation text from pip_install.rst?

@Marcono1234
Copy link
Author

Should I try to work on this? Do we just need to change documentation text from pip_install.rst?

I think that won't work because as mentioned above the documentation for these options does not seem to be part of pip_install.rst but seems to be generated dynamically (from cmdoptions.py?). But I might be wrong.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Documentation related
Projects
None yet
Development

No branches or pull requests

4 participants