Better document the requirements file format #7386
Conversation
There was a problem hiding this comment.
Thanks for finding this and fixing it! Just one comment, otherwise this is OK for me.
The new ordering is a little odd (index options are not together, for example) but no problem fixing it in both places later.
If you want, as a followup (you can make a separate issue if you are interested) it may also be possible to generate this list automatically from SUPPORTED_OPTIONS similar to what we do for command option help here.
Change the documentation for the requirements file format so that it matches the implementation [0]. Also change the order of the options in the implementation so that the documentation reads better. Before this change the documentation included an incomplete list of supported options. This change adds the missing options and changes the order to match, so that the two locations are easier to keep in sync. After this change the list in the documentation matches SUPPORTED_OPTIONS in src/pip/_internal/req/req_file.py [0]: https://github.com/pypa/pip/blob/master/src/pip/_internal/req/req_file.py#L60
Addressed in latest push, thank you.
I agree. To address this I have adjusted the order in the implementation, so that the documentation isn't so odd! I am happy to action any feedback on ordering.
I would like to try that and will open a separate issue and PR later. Thank you for the suggestion. I'll keep this PR to improving the hand written documentation. |
|
Something is up with Azure, we'll give it some time to resolve. |
lock
bot
added
the
auto-locked
Change the documentation for the requirements file format so that it matches the implementation.
Before this change the documentation included an incomplete list of supported options.
This change adds the missing options and changes the order to match, so that the two locations are easier to keep in sync. After this change the list in the documentation matches
SUPPORTED_OPTIONSinsrc/pip/_internal/req/req_file.py.Addresses #7385