Skip to content

gh-130160: use .. program:: directive for documenting idle CLI #130278

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
Merged
merged 14 commits into from
Feb 24, 2025
Merged

gh-130160: use .. program:: directive for documenting idle CLI #130278

merged 14 commits into from
Feb 24, 2025

Conversation

Mr-Sunglasses
Copy link
Contributor

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

@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
@terryjreedy terryjreedy added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 18, 2025
@StanFromIreland
Copy link
Contributor

StanFromIreland commented Feb 19, 2025 •
edited
Loading

I don't think we can use these here because of how help.py for idle is generated. This may destroy the nice indentation we currently have?

New

image

Old

image

Also please run idlelib.help.copy_strip() so that help.html is updated.

terryjreedy
terryjreedy previously requested changes Feb 20, 2025
View reviewed changes
Copy link
Member

@terryjreedy terryjreedy left a comment

Choose a reason for hiding this comment

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

Make changes, but I will want to review some of the other explanation lines before merging.

@bedevere-app
Copy link

bedevere-app bot commented Feb 20, 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.

@Mr-Sunglasses
Copy link
Contributor Author

I have made the requested changes; please review again.

@bedevere-app
Copy link

bedevere-app bot commented Feb 21, 2025

Thanks for making the requested changes!

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

@bedevere-app bedevere-app bot requested a review from terryjreedy February 21, 2025 14:54
@Mr-Sunglasses @StanFromIreland
fix: typo in a subcommand
a3288f5 
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
@terryjreedy terryjreedy requested a review from picnixz February 22, 2025 02:32
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
picnixz
picnixz reviewed Feb 22, 2025
View reviewed changes
terryjreedy and others added 3 commits February 23, 2025 20:55
@terryjreedy @AA-Turner
Update Doc/library/idle.rst
958cece 
Split long line.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@terryjreedy @picnixz
Update Doc/library/idle.rst
16730fe 
Emphasize *options*.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@terryjreedy
Merge branch 'main' into fix/idle-docs-commandline
ab68e84
@terryjreedy terryjreedy dismissed their stale review February 24, 2025 01:59

Satisfied with changes.

@terryjreedy terryjreedy enabled auto-merge (squash) February 24, 2025 02:01
@terryjreedy terryjreedy merged commit 0ff1611 into python:main Feb 24, 2025
27 of 28 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 24, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting idle …
2e6c7f6 
…CLI (pythonGH-130278)

---------
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
(cherry picked from commit 0ff1611)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 24, 2025

GH-130494 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 24, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 24, 2025
@Mr-Sunglasses @miss-islington
pythongh-130160: use .. program:: directive for documenting idle …
b2e18fd 
…CLI (pythonGH-130278)

---------
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
(cherry picked from commit 0ff1611)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 24, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 24, 2025
terryjreedy pushed a commit that referenced this pull request Feb 24, 2025
@miss-islington @Mr-Sunglasses
[3.13] gh-130160: use .. program:: directive for documenting idle…
7661704 
… CLI (GH-130278) (#130494)

gh-130160: use `.. program::` directive for documenting `idle` CLI (GH-130278)

---------




(cherry picked from commit 0ff1611)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
terryjreedy pushed a commit that referenced this pull request Feb 24, 2025
@miss-islington @Mr-Sunglasses
[3.12] gh-130160: use .. program:: directive for documenting idle…
b505d0f 
… CLI (GH-130278) (#130495)

gh-130160: use `.. program::` directive for documenting `idle` CLI (GH-130278)

---------




(cherry picked from commit 0ff1611)

Co-authored-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
@Mr-Sunglasses @seehwan80
pythongh-130160: use .. program:: directive for documenting idle …
531f728 
…CLI (python#130278)

---------
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner AA-Turner left review comments

@picnixz picnixz picnixz left review comments

@terryjreedy terryjreedy terryjreedy left review comments

@StanFromIreland StanFromIreland StanFromIreland left review comments

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
5 participants
@Mr-Sunglasses @StanFromIreland @AA-Turner @picnixz @terryjreedy