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.

Sign up for GitHub

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

Jump to bottom

gh-130160: use .. program:: directive for documenting ensurepip CLI #130253

Merged
merged 2 commits into from
Feb 18, 2025
Merged

gh-130160: use .. program:: directive for documenting ensurepip CLI #130253

merged 2 commits into from
Feb 18, 2025

Conversation

Mr-Sunglasses
Copy link
Contributor

@Mr-Sunglasses Mr-Sunglasses commented Feb 18, 2025 •
edited by github-actions bot
Loading

@cpython-cla-bot CPython CLA Bot
Copy link

cpython-cla-bot bot commented Feb 18, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 18, 2025
@bedevere-app bedevere-app bot mentioned this pull request Feb 18, 2025
Open
6 tasks
@Mr-Sunglasses
Copy link
Contributor Author

@sobolevn , @picnixz ptal

sobolevn
sobolevn reviewed Feb 18, 2025
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

LGTM!
Снимок экрана 2025-02-18 в 14 08 39

I would recommend changing pipX to pipN, because there's now a tool called pipx.

Thanks for the PR and congrats! 🎉

sobolevn
sobolevn reviewed Feb 18, 2025
View reviewed changes
Doc/library/ensurepip.rst Outdated
@@ -75,14 +75,14 @@ through two additional command line options:
for the current Python installation (this option is not permitted inside an
active virtual environment).

By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where
X.Y stands for the version of Python used to invoke ``ensurepip``). The
By default, the scripts ``pipN`` and ``pipN.Y`` will be installed (where
Copy link
Member

Choose a reason for hiding this comment

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

Maybe pipN.M?

Copy link
Member

Choose a reason for hiding this comment

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

Why change this at all? pipX.Y is the normal convention here, used in the pip documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Ok, this change is unrelated anyway and no users complained about it. I agree with @pfmoore

pfmoore
pfmoore requested changes Feb 18, 2025
View reviewed changes
Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

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

Please leave the pipX.Y naming convention unchanged.

@bedevere-app
Copy link

bedevere-app bot commented Feb 18, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@pfmoore
Copy link
Member

pfmoore commented Feb 18, 2025

Sorry I hadn’t seen the comment by @sobolevn regarding the pipx application. Nevertheless, I disagree - the pipX.Y convention is well established, and consistency with existing terminology is important.

@Mr-Sunglasses
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-app
Copy link

bedevere-app bot commented Feb 18, 2025

Thanks for making the requested changes!

@pfmoore: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from pfmoore February 18, 2025 11:51
@pfmoore
Copy link
Member

pfmoore commented Feb 18, 2025

Thanks! LGTM.

@pfmoore pfmoore merged commit 8cd7f8b into python:main Feb 18, 2025
49 of 52 checks passed
@sobolevn
Copy link
Member

We usually backport doc changes, should we in this case?

@sobolevn sobolevn added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Feb 18, 2025
@miss-islington-app
Copy link

Thanks @Mr-Sunglasses for the PR, and @pfmoore for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

Thanks @Mr-Sunglasses for the PR, and @pfmoore for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 18, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting `ensure…
45a3590 
…pip` CLI (pythongh-130253)

(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 18, 2025

GH-130258 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Feb 18, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 18, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting `ensure…
d47bff3 
…pip` CLI (pythongh-130253)

(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 18, 2025

GH-130259 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 18, 2025
@pfmoore
Copy link
Member

pfmoore commented Feb 18, 2025

We usually backport doc changes, should we in this case?

I don't know the policy for doc changes, but if that's the usual approach, I see no reason not to.

pfmoore pushed a commit that referenced this pull request Feb 18, 2025
@miss-islington @Mr-Sunglasses
[3.13] gh-130160: use .. program:: directive for documenting `ensur…
a273543 
…epip` CLI (gh-130253) (gh-130259)

gh-130160: use `.. program::` directive for documenting `ensurepip` CLI (gh-130253)
(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <[email protected]>
pfmoore pushed a commit that referenced this pull request Feb 18, 2025
@miss-islington @Mr-Sunglasses
[3.12] gh-130160: use .. program:: directive for documenting `ensur…
aeefac9 
…epip` CLI (gh-130253) (gh-130258)

gh-130160: use `.. program::` directive for documenting `ensurepip` CLI (gh-130253)
(cherry picked from commit 8cd7f8b)

Co-authored-by: Kanishk Pachauri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sobolevn sobolevn sobolevn left review comments

@pfmoore pfmoore pfmoore approved these changes

@pradyunsg pradyunsg Awaiting requested review from pradyunsg pradyunsg is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use .. program:: and .. option:: directives for modules with a documented CLI
3 participants
@Mr-Sunglasses @pfmoore @sobolevn