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

Display env vars for pip options in docs #12576

Merged
merged 8 commits into from
Mar 16, 2024
Merged

Conversation

luismedel
Copy link
Contributor

@luismedel luismedel commented Mar 14, 2024

Close #8044

This PR contains the same changes as #11993 by @ctg123 but with the missing type hints.

I decided to create a new PR to simplify the merge.

Close #11993

docs/pip_sphinxext.py Outdated Show resolved Hide resolved
@uranusjr
Copy link
Member

Would you mind referencing @ctg123 as the author in the initial commit as well so he shows up as a contributor? This can be done with

$ git rebase -i main  # And change the action on the initial commit from "pick" to "edit".
$ git commit --amend --author="ctg123 <[email protected]>" --no-edit
$ git rebase --continue

@webknjaz
Copy link
Member

@luismedel could you use full sentences in the changelog fragment? It'd also be nice to drop the imperative mood since a changelog is less of an instruction list and more like a news digest with what's changed since the previous release.

Looking good otherwise!

@luismedel
Copy link
Contributor Author

@luismedel could you use full sentences in the changelog fragment? It'd also be nice to drop the imperative mood since a changelog is less of an instruction list and more like a news digest with what's changed since the previous release.

Looking good otherwise!

Thanks. I tried to better clarify the change.

What I'm not really sure is how to escape the imperative mood if the message should continue the "This change will..." idiom, as per the guidelines :-(

news/12576.doc.rst Outdated Show resolved Hide resolved
@pfmoore
Copy link
Member

pfmoore commented Mar 14, 2024

Stick to the guidelines - the news entry looks fine to me (with one minor grammar nit). Not using imperative mood for news entries isn't a principle we use on pip.

Co-authored-by: Paul Moore <[email protected]>
@webknjaz
Copy link
Member

Ah, I didn't realize. Wonder why..

@webknjaz
Copy link
Member

@luismedel it's not explicitly called out, but if you look into the old changelogs, most of the entries are full sentences with a trailing period. Might be worth fixing?

@luismedel
Copy link
Contributor Author

@luismedel it's not explicitly called out, but if you look into the old changelogs, most of the entries are full sentences with a trailing period. Might be worth fixing?

@webknjaz sure!

@pfmoore pfmoore merged commit 303fed3 into pypa:main Mar 16, 2024
12 checks passed
@pfmoore
Copy link
Member

pfmoore commented Mar 16, 2024

Thanks for the PR!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the environment variables which influence pip's behaviour
6 participants