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

Fix pip config docstring to render correctly in docs #8073

Merged
merged 1 commit into from
May 23, 2020

Conversation

deveshks
Copy link
Contributor

@deveshks deveshks commented Apr 17, 2020

Fixes and closes #8072

The formatting is picked from https://github.com/pypa/pip/blob/master/src/pip/_internal/commands/download.py#L19 and the docs now look like

Screenshot 2020-04-18 at 1 05 20 AM

They pip config doc can also do with some examples as well, but I can perhaps make a separate PR for that.

$ pip config set site.proxy 'http://localhost:3128'
Writing to ~/.config/pip/pip.conf
$ pip config get site.proxy
http://localhost:3128
$ pip config list
site.proxy='http://localhost:3128'

Edit: Seems like the docstring indentation was changed in bbd4398 but that didn't correct the rendering

@deveshks
Copy link
Contributor Author

If there are no more changes needed here, may I get this PR merged?

@pradyunsg pradyunsg added the type: docs Documentation related label May 23, 2020
Copy link
Member

@pradyunsg pradyunsg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably do this to pip cache as well!

@pradyunsg pradyunsg merged commit 75b2800 into pypa:master May 23, 2020
@deveshks deveshks deleted the pip-config-docstring-fix branch May 23, 2020 11:53
@deveshks
Copy link
Contributor Author

We should probably do this to pip cache as well!

Done in #8313

@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
type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Description section of pip config is ill-formatted
4 participants