diff options
author | Tian Gao <gaogaotiantian@hotmail.com> | 2023-04-11 22:40:30 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-11 22:40:30 (GMT) |
commit | 2f41a009b7311a4b44bae5b3583cde3d6d10d8d1 (patch) | |
tree | 3e4e9df8a4008e41e78bb9f244f65eba6d5ee298 /Doc/library/pdb.rst | |
parent | 96663875b2ea55c65e83551cdb741bbcdcaa7f21 (diff) | |
download | cpython-2f41a009b7311a4b44bae5b3583cde3d6d10d8d1.zip cpython-2f41a009b7311a4b44bae5b3583cde3d6d10d8d1.tar.gz cpython-2f41a009b7311a4b44bae5b3583cde3d6d10d8d1.tar.bz2 |
gh-103143: Polish pdb help messages and doc strings (GH-103144)
* Made all the command part of the docstring match the official documentation
* Always have a space between the command and the description in docstring
* Added a helper function to format the help message
Before:
```
(Pdb) h a
a(rgs)
Print the argument list of the current function.
(Pdb) h commands
commands [bpnumber]
(com) ...
(com) end
(Pdb)
...
(Pdb) h interact
interact
Start an interactive interpreter whose global namespace
contains all the (global and local) names found in the current scope.
```
After
```
(Pdb) h a
Usage: a(rgs)
Print the argument list of the current function.
(Pdb) h commands
Usage: (Pdb) commands [bpnumber]
(com) ...
(com) end
(Pdb)
...
(Pdb) h interact
Usage: interact
Start an interactive interpreter whose global namespace
contains all the (global and local) names found in the current scope.
```
Automerge-Triggered-By: GH:brandtbucher
Diffstat (limited to 'Doc/library/pdb.rst')
-rw-r--r-- | Doc/library/pdb.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst index d80c5ee..4170882 100644 --- a/Doc/library/pdb.rst +++ b/Doc/library/pdb.rst @@ -315,14 +315,14 @@ can be overridden by the local file. With a space separated list of breakpoint numbers, clear those breakpoints. Without argument, clear all breaks (but first ask confirmation). -.. pdbcommand:: disable [bpnumber ...] +.. pdbcommand:: disable bpnumber [bpnumber ...] Disable the breakpoints given as a space separated list of breakpoint numbers. Disabling a breakpoint means it cannot cause the program to stop execution, but unlike clearing a breakpoint, it remains in the list of breakpoints and can be (re-)enabled. -.. pdbcommand:: enable [bpnumber ...] +.. pdbcommand:: enable bpnumber [bpnumber ...] Enable the breakpoints specified. |