Skip to content

Add .. versionadded directive to dis CLI options#130267

Merged
sobolevn merged 1 commit intopython:mainfrom
sobolevn:dis-options-versions
Feb 21, 2025
Merged

Add .. versionadded directive to dis CLI options#130267
sobolevn merged 1 commit intopython:mainfrom
sobolevn:dis-options-versions

Conversation

@sobolevn
Copy link
Copy Markdown
Member

@sobolevn sobolevn commented Feb 18, 2025 •
edited by github-actions bot
Loading

I think that these directives are useful, because a lot of the times users just browse /3/ version. And might use options that do not exist in their version.

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

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Feb 18, 2025
StanFromIreland
StanFromIreland approved these changes Feb 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

I don't see any reason why not!

picnixz
picnixz approved these changes Feb 21, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

We do have the versionadded at the very top of the page I think but it's nice to have them next to the options themselves.

@sobolevn sobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 21, 2025
@sobolevn sobolevn merged commit 9bf73c0 into python:main Feb 21, 2025
8 checks passed
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app bot commented Feb 21, 2025

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app bot commented Feb 21, 2025

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

cherry_picker 9bf73c032fbf0ea27ebf6e53223c3bc69ee0dbc5 3.13

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app bot commented Feb 21, 2025

Sorry, @sobolevn, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 9bf73c032fbf0ea27ebf6e53223c3bc69ee0dbc5 3.12

sobolevn added a commit to sobolevn/cpython that referenced this pull request Feb 21, 2025
@sobolevn
[3.13] Add .. versionadded directive to dis CLI options (pythonGH…
6e50545 
…-130267)

(cherry picked from commit 9bf73c0)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link
Copy Markdown

bedevere-app bot commented Feb 21, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 21, 2025
@sobolevn sobolevn removed the needs backport to 3.12 only security fixes label Feb 21, 2025
@sobolevn
Copy link
Copy Markdown
Member Author

sobolevn commented Feb 21, 2025

3.13 backport is done, 3.12 does not need one.

sobolevn added a commit that referenced this pull request Feb 21, 2025
@sobolevn
[3.13] Add .. versionadded directive to dis CLI options (GH-130267)…
2a978e1 
… (#130401)

(cherry picked from commit 9bf73c0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz approved these changes

@StanFromIreland StanFromIreland StanFromIreland approved these changes

@iritkatriel iritkatriel Awaiting requested review from iritkatriel

Assignees

@sobolevn sobolevn

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sobolevn @picnixz @StanFromIreland