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 `doctest` CLI by donbarbos · Pull Request #131034 · python/cpython

Conversation

@donbarbos

@donbarbos donbarbos commented Mar 10, 2025 •
edited by github-actions Bot
Loading

Uh oh!

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

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@donbarbos
use .. program:: directive for documenting doctest CLI
805ce58
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 10, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Mar 10, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Mar 10, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Mar 10, 2025
Use .. program:: and .. option:: directives for modules with a documented CLI #130160
Closed
6 tasks done
@donbarbos
Correct ref syntax
56c2b7c
sobolevn
sobolevn approved these changes Mar 10, 2025
View reviewed changes

@sobolevn sobolevn 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.

Much better in my opinion, let's wait for others :)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
donbarbos reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels Mar 10, 2025
@donbarbos

donbarbos commented Mar 15, 2025

Copy link
Copy Markdown
Contributor Author

cc @picnixz
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
picnixz
picnixz approved these changes Mar 16, 2025
View reviewed changes

@picnixz picnixz 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.

Small nit and LGTM.

Sorry, something went wrong.

Uh oh!

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

Uh oh!

There was an error while loading. Please reload this page.
@picnixz picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Mar 16, 2025
@donbarbos @picnixz
Update doctest.rst
a5c8c59 
Co-authored-by: Bénédikt Tran <[email protected]>
@picnixz
picnixz enabled auto-merge (squash) March 16, 2025 11:49
@picnixz
picnixz merged commit 9558d22 into python:main Mar 16, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 16, 2025
@bedevere-app bedevere-app Bot removed the awaiting merge label Mar 16, 2025
@miss-islington-app

miss-islington-app Bot commented Mar 16, 2025

Copy link
Copy Markdown

Thanks @donbarbos for the PR, and @picnixz 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 Mar 16, 2025
@donbarbos @picnixz @miss-islington
pythongh-130160: use .. program:: directive for documenting `doctes…
01be588 
…t` CLI (pythonGH-131034)

(cherry picked from commit 9558d22)

Co-authored-by: donBarbos <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
@bedevere-app

bedevere-app Bot commented Mar 16, 2025

Copy link
Copy Markdown

GH-131320 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 Mar 16, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 16, 2025
@donbarbos @picnixz @miss-islington
pythongh-130160: use .. program:: directive for documenting `doctes…
b0069cd 
…t` CLI (pythonGH-131034)

(cherry picked from commit 9558d22)

Co-authored-by: donBarbos <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
@bedevere-app

bedevere-app Bot commented Mar 16, 2025

Copy link
Copy Markdown

GH-131321 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 Mar 16, 2025
picnixz added a commit that referenced this pull request Mar 16, 2025
@miss-islington @donbarbos @picnixz
[3.13] gh-130160: use .. program:: directive for documenting `docte…
1512cc0 
…st` CLI (GH-131034) (#131320)

gh-130160: use `.. program::` directive for documenting `doctest` CLI (GH-131034)
(cherry picked from commit 9558d22)

Co-authored-by: donBarbos <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
picnixz added a commit that referenced this pull request Mar 16, 2025
@miss-islington @donbarbos @picnixz
[3.12] gh-130160: use .. program:: directive for documenting `docte…
1d17f1a 
…st` CLI (GH-131034) (#131321)

gh-130160: use `.. program::` directive for documenting `doctest` CLI (GH-131034)
(cherry picked from commit 9558d22)

Co-authored-by: donBarbos <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
mikec9 pushed a commit to mikec9/cpython that referenced this pull request Mar 17, 2025
@miss-islington @donbarbos
@picnixz mike c
[3.13] pythongh-130160: use .. program:: directive for documenting …
cd2755d 
…`doctest` CLI (pythonGH-131034) (python#131320)

pythongh-130160: use `.. program::` directive for documenting `doctest` CLI (pythonGH-131034)
(cherry picked from commit 9558d22)

Co-authored-by: donBarbos <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
plashchynski pushed a commit to plashchynski/cpython that referenced this pull request Mar 17, 2025
@donbarbos @picnixz @plashchynski
pythongh-130160: use .. program:: directive for documenting `doctes…
6f55ae5 
…t` CLI (python#131034)

Co-authored-by: Bénédikt Tran <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sobolevn sobolevn sobolevn approved these changes
@picnixz picnixz picnixz approved these changes

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.

Uh oh!

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

3 participants

@donbarbos @sobolevn @picnixz
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.