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

Requirements file format documentation is incomplete #7385

Closed
maxwell-k opened this issue Nov 19, 2019 · 0 comments
Closed

Requirements file format documentation is incomplete #7385

maxwell-k opened this issue Nov 19, 2019 · 0 comments

Comments

@maxwell-k
Copy link
Contributor

@maxwell-k maxwell-k commented Nov 19, 2019

Environment

  • pip version: master
  • Python version: all (Python 3.7)
  • OS: all (Linux)

This is an issue with the documentation.

Description

The current requirements file format section of the documentation is incomplete and therefore misleading: https://pip.pypa.io/en/latest/reference/pip_install/#requirements-file-format

It can lead a reader to understand that certain content is not supported, when it is in fact supported.

Expected behavior

The requirements file format documentation should be a comprehensive explanation of what is permitted in a requirements file. A reader should be able to identify what is allowed from the documentation without having to read the underlying source code.

How to Reproduce

  1. Browse to https://pip.pypa.io/en/latest/reference/pip_install/#requirements-file-format
  2. Compare the list under "The following options are supported:" with
  3. SUPPORTED_OPTIONS in https://github.com/pypa/pip/blob/master/src/pip/_internal/req/req_file.py#L60

Output

Five supported options are missing from the list:

  • -c, --constraint
  • -e, --editable
  • -r, --requirement
  • --pre
  • -Z, --always-unzip
@triage-new-issues triage-new-issues bot added the triage label Nov 19, 2019
@maxwell-k maxwell-k closed this Nov 20, 2019
@lock lock bot added the S: auto-locked label Dec 20, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Dec 20, 2019
@triage-new-issues triage-new-issues bot removed the triage label Dec 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.