-
-
Notifications
You must be signed in to change notification settings - Fork 423
[skip changelog] [skip ci] Clarify additional-urls option usage #548
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
Conversation
README.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/require/requires
README.rst
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we could stress the fact that you always have to pass the option if you decide to not use the config file, something on these lines:
Alternatively, you can pass a link to the the additional package index file with the
--additional-urlsoption, but this has to be done every time and for every command that operates on a platform core, for example:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 I have rephrased it a bit, please check if it makes sense.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:shipit:
This PR propose the usage of the config file option as best mode for 3rd party core usage.
The
--additional-urlsflag is now presented as an alternative, adding a complete usage explanation.