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

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

terryjreedy merged 14 commits into from
Feb 24, 2025

Conversation

@Mr-Sunglasses
Copy link
Contributor

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

@bedevere-appbedevere-appbot added docs Documentation in the Doc dir skip news awaiting review labels Feb 18, 2025
@bedevere-appbedevere-appbot mentioned this pull request Feb 18, 2025
Closed
6 tasks
@terryjreedyterryjreedy 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
Member

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

@terryjreedyterryjreedy 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-appbot 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
ContributorAuthor

Mr-Sunglasses commented Feb 21, 2025

I have made the requested changes; please review again.

@bedevere-app
Copy link

bedevere-appbot commented Feb 21, 2025

Thanks for making the requested changes!

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

StanFromIreland
StanFromIreland reviewed Feb 21, 2025
View reviewed changes
@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 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
terryjreedyand 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
@terryjreedyterryjreedy dismissed their stale reviewFebruary 24, 2025 01:59

Satisfied with changes.

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

miss-islington-appbot commented Feb 24, 2025

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 documentingidle…
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-appbot commented Feb 24, 2025

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

@bedevere-appbedevere-appbot 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 documentingidle…
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-appbot commented Feb 24, 2025

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

@bedevere-appbedevere-appbot 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 documentingidle…
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 documentingidle…
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-TurnerAA-TurnerAA-Turner left review comments

@picnixzpicnixzpicnixz left review comments

@terryjreedyterryjreedyterryjreedy left review comments

@StanFromIrelandStanFromIrelandStanFromIreland left review comments

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip 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