--extra-index-url
option documentation should have warning about "dependency confusion"
#11694
Open
1 task done
Labels
type: docs
Documentation related
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
The text was updated successfully, but these errors were encountered: