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

Description section of pip config is ill-formatted #8072

Closed
deveshks opened this issue Apr 17, 2020 · 0 comments · Fixed by #8073
Closed

Description section of pip config is ill-formatted #8072

deveshks opened this issue Apr 17, 2020 · 0 comments · Fixed by #8073
Labels
auto-locked Outdated issues that have been locked by automation

Comments

@deveshks
Copy link
Contributor

deveshks commented Apr 17, 2020

The section of docs for pip config Description is not well formatted. There is supposed to be a sublist under the subcommands section and rendered as per

class ConfigurationCommand(Command):
"""Manage local and global configuration.
Subcommands:
list: List the active configuration (or from the file specified)
edit: Edit the configuration file in an editor
get: Get the value associated with name
set: Set the name=value
unset: Unset the value associated with name
If none of --user, --global and --site are passed, a virtual
environment configuration file is used if one is active and the file
exists. Otherwise, all modifications happen on the to the user file by
default.
"""

But in the docs, all the options end up in a single paragraph

Screenshot 2020-04-18 at 12 59 40 AM

@triage-new-issues triage-new-issues bot added the S: needs triage Issues/PRs that need to be triaged label Apr 17, 2020
@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 24, 2020
@triage-new-issues triage-new-issues bot removed the S: needs triage Issues/PRs that need to be triaged label Jun 24, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Jun 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant