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

Extract supported requirement file options automatically #7456

Closed
chrahunt opened this issue Dec 8, 2019 · 0 comments · Fixed by #7908
Closed

Extract supported requirement file options automatically #7456

chrahunt opened this issue Dec 8, 2019 · 0 comments · Fixed by #7908
Labels
help wanted For requesting inputs from other members of the community state: awaiting PR Feature discussed, PR is needed type: docs Documentation related

Comments

@chrahunt
Copy link
Member

chrahunt commented Dec 8, 2019

What's the problem this feature will solve?

Currently the documentation for what options are possible in requirements files are hand-maintained in the docs, but actually enforced in the code. Maintaining the list in both places is error-prone.

Describe the solution you'd like

Automatically extract the supported options from the lists of options in pip._internal.req.req_file here.

The approach should be similar to what we do for command option help here. We should also make sure to clearly separate the general options, which must be on their own line in a requirements file, from the requirement-specific options, which must be on the same line as a requirement.

Alternative Solutions

  • Continue to manually maintain the lists in both places

Additional context

@chrahunt chrahunt added type: docs Documentation related state: awaiting PR Feature discussed, PR is needed help wanted For requesting inputs from other members of the community labels Dec 8, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted For requesting inputs from other members of the community state: awaiting PR Feature discussed, PR is needed type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant