gh-130160: use .. program:: directive for documenting cProfile CLI
#130314
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bedevere-app
bot
added
docs
6 tasks
sobolevn
reviewed
Feb 19, 2025
Doc/library/profile.rst
Outdated
|
|
||
| .. option:: -m <module> | ||
|
|
||
| Specifies that a module is being profiled instead of a script. | ||
|
|
||
| .. versionadded:: 3.7 |
There was a problem hiding this comment.
Please, indent these values to be in -m section.
sobolevn
reviewed
Feb 20, 2025
picnixz
reviewed
Feb 21, 2025
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
AA-Turner
approved these changes
Feb 22, 2025
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
sobolevn
added
needs backport to 3.12
|
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>
|
GH-130745 is a backport of this pull request to the 3.13 branch. |
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>
|
GH-130746 is a backport of this pull request to the 3.12 branch. |
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>
seehwan
pushed a commit
to seehwan/cpython
that referenced
this pull request
Apr 16, 2025
…le` CLI (python#130314) 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use
.. program::and.. option::directive for documentingcProfileCLI.. program::and.. option::directives for modules with a documented CLI #130160📚 Documentation preview 📚: https://cpython-previews--130314.org.readthedocs.build/