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

Conversation

@donbarbos

@donbarbos donbarbos commented Mar 9, 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--130996.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 pdb CLI
1079ebc
@donbarbos
donbarbos requested a review from gaogaotiantian as a code owner March 9, 2025 02:01
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 9, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs Mar 9, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Mar 9, 2025
@bedevere-app bedevere-app Bot mentioned this pull request Mar 9, 2025
Use .. program:: and .. option:: directives for modules with a documented CLI #130160
Closed
6 tasks done
gaogaotiantian
gaogaotiantian reviewed Mar 9, 2025
View reviewed changes
Comment thread Doc/library/pdb.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@donbarbos @gaogaotiantian
Update pdb.rst
a0384db 
Co-authored-by: Tian Gao <[email protected]>
gaogaotiantian
gaogaotiantian reviewed Mar 9, 2025
View reviewed changes
Comment thread Doc/library/pdb.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
donbarbos added 2 commits March 9, 2025 17:39
@donbarbos
Update pdb.rst
53cfeda
@donbarbos
Merge branch 'main' into issue-130160-pdb
7dc8b21
gaogaotiantian
gaogaotiantian approved these changes Mar 9, 2025
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels Mar 9, 2025
@gaogaotiantian
gaogaotiantian merged commit c240c2d into python:main Mar 9, 2025
@bedevere-app bedevere-app Bot removed the awaiting merge label Mar 9, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 9, 2025
@donbarbos

donbarbos commented Mar 9, 2025 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor Author

@gaogaotiantian thank you for review, but I thought this issue was awaiting backports
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@gaogaotiantian gaogaotiantian added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Mar 9, 2025
@miss-islington-app

miss-islington-app Bot commented Mar 9, 2025

Copy link
Copy Markdown

Thanks @donbarbos for the PR, and @gaogaotiantian for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app

miss-islington-app Bot commented Mar 9, 2025

Copy link
Copy Markdown

Thanks @donbarbos for the PR, and @gaogaotiantian for merging it 🌮🎉.. I'm working now to backport this PR to: 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 9, 2025
@donbarbos @miss-islington
pythongh-130160: use .. program:: directive for documenting pdb C…
c773bbb 
…LI (pythonGH-130996)

(cherry picked from commit c240c2d)

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

bedevere-app Bot commented Mar 9, 2025

Copy link
Copy Markdown

GH-131013 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 9, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 9, 2025
@donbarbos @miss-islington
pythongh-130160: use .. program:: directive for documenting pdb C…
9d9f142 
…LI (pythonGH-130996)

(cherry picked from commit c240c2d)

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

bedevere-app Bot commented Mar 9, 2025

Copy link
Copy Markdown

GH-131014 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 9, 2025
@gaogaotiantian

gaogaotiantian commented Mar 9, 2025

Copy link
Copy Markdown
Member

Huh, I did not realize that we are backporting a documentation improvement. However all the other PRs seem to be backported, so I'm fine with it.
donbarbos reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

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

donbarbos commented Mar 9, 2025

Copy link
Copy Markdown
Contributor Author

Thanks
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
gaogaotiantian pushed a commit that referenced this pull request Mar 9, 2025
@miss-islington @donbarbos
[3.13] gh-130160: use .. program:: directive for documenting pdb …
28406cd 
…CLI (GH-130996) (#131014)

gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996)
(cherry picked from commit c240c2d)

Co-authored-by: donBarbos <[email protected]>
gaogaotiantian pushed a commit that referenced this pull request Mar 9, 2025
@miss-islington @donbarbos
[3.12] gh-130160: use .. program:: directive for documenting pdb …
9f7f2c0 
…CLI (GH-130996) (#131013)

gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996)
(cherry picked from commit c240c2d)

Co-authored-by: donBarbos <[email protected]>
@picnixz

picnixz commented Mar 9, 2025

Copy link
Copy Markdown
Member

Huh, I did not realize that we are backporting a documentation improvement

Usually docs are backported even when manual backports due to missing/new pieces are needed. That's mostly IMO because docs are continously read and need to be as clear and up-to-date as possible.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz left review comments
@gaogaotiantian gaogaotiantian gaogaotiantian 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 @gaogaotiantian @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.