-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
gh-130160: use .. program:: directive for documenting cProfile CLI
#130314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
sobolevn
left a comment
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.
Doc/library/profile.rst
Outdated
|
|
||
| Specifies that a module is being profiled instead of a script. | ||
|
|
||
| .. versionadded:: 3.7 |
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.
Please, indent these values to be in -m section.
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>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
sobolevn
left a comment
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.
Thank you!
|
Thanks @ApostolFet for the PR, and @sobolevn for merging it 馃尞馃帀.. I'm working now to backport this PR to: 3.12, 3.13. |
鈥e` 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. |
鈥e` 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. |
鈥le` 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>
鈥le` 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>
鈥 (#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>

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/