FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.13] gh-130160: use `.. program::` directive for documenting `pdb` CLI (GH-130996) by miss-islington · Pull Request #131014 · python/cpython · GitHub

/ cpython Public

[3.13] gh-130160: use .. program:: directive for documenting pdb CLI (GH-130996) #131014

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gaogaotiantian merged 1 commit into from
Mar 9, 2025
Conversation 0 Commits 1 Checks 0 Files changed
Merged

[3.13] gh-130160: use .. program:: directive for documenting pdb CLI (GH-130996) #131014

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
25 changes: 17 additions & 8 deletions Doc/library/pdb.rst
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -75,25 +75,34 @@ The debugger's prompt is ``(Pdb)``, which is the indicator that you are in debug
arguments of the ``p`` command.


.. program:: pdb

You can also invoke :mod:`pdb` from the command line to debug other scripts. For
example::

python -m pdb myscript.py
python -m pdb [-c command] (-m module | pyfile) [args ...]

When invoked as a module, pdb will automatically enter post-mortem debugging if
the program being debugged exits abnormally. After post-mortem debugging (or
after normal exit of the program), pdb will restart the program. Automatic
restarting preserves pdb's state (such as breakpoints) and in most cases is more
useful than quitting the debugger upon program's exit.

.. versionchanged:: 3.2
Added the ``-c`` option to execute commands as if given
in a :file:`.pdbrc` file; see :ref:`debugger-commands`.
.. option:: -c, --command <command>

.. versionchanged:: 3.7
Added the ``-m`` option to execute modules similar to the way
``python -m`` does. As with a script, the debugger will pause execution just
before the first line of the module.
To execute commands as if given in a :file:`.pdbrc` file; see
:ref:`debugger-commands`.

.. versionchanged:: 3.2
Added the ``-c`` option.

.. option:: -m <module>

To execute modules similar to the way ``python -m`` does. As with a script,
the debugger will pause execution just before the first line of the module.

.. versionchanged:: 3.7
Added the ``-m`` option.

Typical usage to execute a statement under control of the debugger is::

Expand Down
Back | FazBrowse Home | New Git URL