FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-130160: use `.. program::` directive for documenting `idle` CLI by Mr-Sunglasses · Pull Request #130278 · python/cpython · GitHub

/ cpython Public

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

Merged
terryjreedy merged 14 commits into
python:mainfrom
Mr-Sunglasses:fix/idle-docs-commandline
Feb 24, 2025
ConversationCommits (14)ChecksFiles changed
Merged

gh-130160: use .. program:: directive for documenting idle CLI#130278
terryjreedy merged 14 commits into
python:mainfrom
Mr-Sunglasses:fix/idle-docs-commandline

Conversation

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

Copy link
Copy Markdown
Contributor

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Feb 18, 2025
bedevere-app Bot mentioned this pull request Feb 18, 2025
Closed
6 tasks
terryjreedy added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 18, 2025

StanFromIreland commented Feb 19, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

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

Old

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

terryjreedy previously requested changes Feb 20, 2025
View reviewed changes

terryjreedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread Doc/library/idle.rst Outdated
Comment thread Doc/library/idle.rst Outdated

bedevere-app Bot commented Feb 20, 2025

Copy link
Copy Markdown

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 commented Feb 21, 2025

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.

bedevere-app Bot commented Feb 21, 2025

Copy link
Copy Markdown

Thanks for making the requested changes!

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

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

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

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

Satisfied with changes.

terryjreedy enabled auto-merge (squash) February 24, 2025 02:01
terryjreedy merged commit 0ff1611 into python:main Feb 24, 2025

miss-islington-app Bot commented Feb 24, 2025

Copy link
Copy Markdown

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
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 Bot commented Feb 24, 2025

Copy link
Copy Markdown

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

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
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 Bot commented Feb 24, 2025

Copy link
Copy Markdown

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

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
[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
[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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AA-Turner AA-Turner left review comments
picnixz picnixz left review comments
terryjreedy terryjreedy left review comments
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

Back | FazBrowse Home | New Git URL