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

Conversation

@donbarbos

@donbarbos donbarbos commented May 3, 2025 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor

based on: #131542 (comment)

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

📚 Documentation preview 📚: https://cpython-previews--133335.org.readthedocs.build/en/133335/library/platform.html#command-line-usage

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@donbarbos
use .. program:: directive for documenting platform CLI
a0de96c
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels May 3, 2025
@bedevere-app bedevere-app Bot mentioned this pull request May 3, 2025
Use .. program:: and .. option:: directives for modules with a documented CLI #130160
Closed
6 tasks done
@bedevere-app bedevere-app Bot added the awaiting review label May 3, 2025
@github-project-automation github-project-automation Bot added this to Docs PRs May 3, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs May 3, 2025
donbarbos added 3 commits May 3, 2025 13:42
@donbarbos
Fix func link
dea95f7
@donbarbos
Add .. versionadded:: directive
4513a95
@donbarbos
Revert "Add .. versionadded:: directive"
1804969 
This reverts commit 4513a95.
hugovk
hugovk approved these changes May 3, 2025
View reviewed changes

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

Thanks!

Sorry, something went wrong.

Uh oh!

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

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting review labels May 3, 2025
@donbarbos
Fix headings
4aff409
@hugovk
hugovk merged commit 1550c30 into python:main May 3, 2025
@bedevere-app bedevere-app Bot removed the awaiting merge label May 3, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs May 3, 2025
@hugovk hugovk added the needs backport to 3.13 only security fixes label May 3, 2025
@miss-islington-app

miss-islington-app Bot commented May 3, 2025

Copy link
Copy Markdown

Thanks @donbarbos for the PR, and @hugovk 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-app

miss-islington-app Bot commented May 3, 2025

Copy link
Copy Markdown

Sorry, @donbarbos and @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 1550c30fd5f2f2902bbcbf64165ae904ebcf7e81 3.13
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 assigned hugovk May 3, 2025
@bedevere-app

bedevere-app Bot commented May 3, 2025

Copy link
Copy Markdown

GH-133341 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 May 3, 2025
hugovk pushed a commit to hugovk/cpython that referenced this pull request May 3, 2025
@donbarbos @hugovk
[3.13] pythongh-130160: use .. program:: directive for documenting …
4b9432e 
…`platform` CLI (pythonGH-133335)

(cherry picked from commit 1550c30)

Co-authored-by: Semyon Moroz <[email protected]>
hugovk added a commit that referenced this pull request May 3, 2025
@hugovk @donbarbos
[3.13] gh-130160: use .. program:: directive for documenting `platf…
130491f 
…orm` CLI (GH-133335) (#133341)

Co-authored-by: Semyon Moroz <[email protected]>
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@donbarbos @Pranjal095
pythongh-130160: use .. program:: directive for documenting `platfo…
fb1cfbb 
…rm` CLI (python#133335)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

Uh oh!

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

Assignees

@hugovk hugovk

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.

2 participants

@donbarbos @hugovk
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.