Skip to content

Conversation

@ApostolFet
Copy link
Contributor

@ApostolFetApostolFet commented Feb 19, 2025

Use .. program:: and .. option:: directive for documenting cProfile CLI


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

Copy link
Member

@sobolevnsobolevn left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!
Снимок экрана 2025-02-19 в 21 52 10


Specifies that a module is being profiled instead of a script.

.. versionadded:: 3.7
Copy link
Member

Choose a reason for hiding this comment

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

Please, indent these values to be in -m section.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
ApostolFetand others added 2 commits February 23, 2025 11:05
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Copy link
Member

@sobolevnsobolevn left a comment

Choose a reason for hiding this comment

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

Thank you!

@sobolevnsobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 1, 2025
@sobolevnsobolevn merged commit 5181ddb into python:mainMar 1, 2025
28 checks passed
@github-project-automationgithub-project-automationbot moved this from Todo to Done in Docs PRsMar 1, 2025
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 1, 2025
…le` CLI (pythonGH-130314) (cherry picked from commit 5181ddb) Co-authored-by: Apostol Fet <90645107+ApostolFet@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.13 bugs and security fixes label Mar 1, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 1, 2025
…le` CLI (pythonGH-130314) (cherry picked from commit 5181ddb) Co-authored-by: Apostol Fet <90645107+ApostolFet@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

GH-130746 is a backport of this pull request to the 3.12 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label Mar 1, 2025
sobolevn pushed a commit that referenced this pull request Mar 1, 2025
…ile` CLI (GH-130314) (#130745) gh-130160: use `.. program::` directive for documenting `cProfile` CLI (GH-130314) (cherry picked from commit 5181ddb) Co-authored-by: Apostol Fet <90645107+ApostolFet@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
sobolevn pushed a commit that referenced this pull request Mar 1, 2025
…ile` CLI (GH-130314) (#130746) gh-130160: use `.. program::` directive for documenting `cProfile` CLI (GH-130314) (cherry picked from commit 5181ddb) Co-authored-by: Apostol Fet <90645107+ApostolFet@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@ApostolFetApostolFet deleted the fix-issue-130160 branch March 2, 2025 07:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants

@ApostolFet@sobolevn@AA-Turner@picnixz