summaryrefslogtreecommitdiffstats
path: root/Misc
diff options
context:
space:
mode:
authorTian Gao <gaogaotiantian@hotmail.com>2023-04-11 22:40:30 (GMT)
committerGitHub <noreply@github.com>2023-04-11 22:40:30 (GMT)
commit2f41a009b7311a4b44bae5b3583cde3d6d10d8d1 (patch)
tree3e4e9df8a4008e41e78bb9f244f65eba6d5ee298 /Misc
parent96663875b2ea55c65e83551cdb741bbcdcaa7f21 (diff)
downloadcpython-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 'Misc')
-rw-r--r--Misc/NEWS.d/next/Library/2023-03-31-01-13-00.gh-issue-103143.6eMluy.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Misc/NEWS.d/next/Library/2023-03-31-01-13-00.gh-issue-103143.6eMluy.rst b/Misc/NEWS.d/next/Library/2023-03-31-01-13-00.gh-issue-103143.6eMluy.rst
new file mode 100644
index 0000000..32bd62d
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2023-03-31-01-13-00.gh-issue-103143.6eMluy.rst
@@ -0,0 +1 @@
+Polish the help messages and docstrings of :mod:`pdb`.