GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-130160: use `.. program::` directive for documenting `idle` CLI by Mr-Sunglasses · Pull Request #130278 · python/cpython

Conversation

@Mr-Sunglasses

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

fix: #130160

  • Issue: Use .. program:: and .. option:: directives for modules with a documented CLI #130160

📚 Documentation preview 📚: https://cpython-previews--130278.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Mr-Sunglasses
pythongh-130160: use .. program:: directive for documenting idle CLI
df3a182
@Mr-Sunglasses
Mr-Sunglasses requested a review from terryjreedy as a code owner February 18, 2025 17:21
@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
Use .. program:: and .. option:: directives for modules with a documented CLI #130160
Closed
6 tasks done
@terryjreedy terryjreedy added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Feb 18, 2025
@StanFromIreland

StanFromIreland commented Feb 19, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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

image

Old

image

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
terryjreedy
terryjreedy previously requested changes Feb 20, 2025
View reviewed changes

@terryjreedy terryjreedy left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting changes and removed awaiting review labels Feb 20, 2025
@bedevere-app

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Mr-Sunglasses
fix: some subcommand and docs
19f6d9c
@Mr-Sunglasses

Mr-Sunglasses commented Feb 21, 2025

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting change review and removed awaiting changes labels Feb 21, 2025
@bedevere-app

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app
bedevere-app Bot requested a review from terryjreedy February 21, 2025 14:54
Mr-Sunglasses added 3 commits February 21, 2025 20:39
@Mr-Sunglasses
fix: linting errors
147f909
@Mr-Sunglasses
fix: error in the linting
50805d5
@Mr-Sunglasses
fix: error Explicit markup ends without a blank line;
a6c38be
StanFromIreland
StanFromIreland reviewed Feb 21, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@Mr-Sunglasses @StanFromIreland
fix: typo in a subcommand
a3288f5 
Co-authored-by: Stan Ulbrych <[email protected]>
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@terryjreedy
Update Doc/library/idle.rst
00683c8
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@terryjreedy
Update Doc/library/idle.rst
2e9b8e4
@terryjreedy
terryjreedy requested a review from picnixz February 22, 2025 02:32
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@terryjreedy
Update Doc/library/idle.rst
9f1eaae
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
terryjreedy added 2 commits February 21, 2025 21:41
@terryjreedy
Update Doc/library/idle.rst
7a21e24
@terryjreedy
Merge branch 'main' into fix/idle-docs-commandline
4d5ac2e
terryjreedy
terryjreedy reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
picnixz
picnixz reviewed Feb 22, 2025
View reviewed changes
Comment thread Doc/library/idle.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
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 <[email protected]>
@terryjreedy @picnixz
Update Doc/library/idle.rst
16730fe 
Emphasize *options*.

Co-authored-by: Bénédikt Tran <[email protected]>
@terryjreedy
Merge branch 'main' into fix/idle-docs-commandline
ab68e84
@terryjreedy
terryjreedy dismissed their stale review February 24, 2025 01:59

Satisfied with changes.

@bedevere-app bedevere-app Bot added awaiting review and removed awaiting change review labels Feb 24, 2025
@terryjreedy
terryjreedy enabled auto-merge (squash) February 24, 2025 02:01
@terryjreedy
terryjreedy merged commit 0ff1611 into python:main Feb 24, 2025
@bedevere-app bedevere-app Bot removed the awaiting review label Feb 24, 2025
@miss-islington-app

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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
(cherry picked from commit 0ff1611)

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

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only 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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
(cherry picked from commit 0ff1611)

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

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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 <[email protected]>
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 <[email protected]>
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

Uh oh!

There was an error while loading. Please reload this page.

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

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@Mr-Sunglasses @StanFromIreland @AA-Turner @picnixz @terryjreedy
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.