[Python-checkins] bpo-32724: Fix references to commands in Doc/pdb.rst (GH-5444)

[Andrew Svetlov]

https://github.com/python/cpython/commit/67adb31a416864f853772c3e74a06caeadc9b6f1
commit: 67adb31a416864f853772c3e74a06caeadc9b6f1
branch: master
author: Stéphane Wirtel <stephane at wirtel.be>
committer: Andrew Svetlov <andrew.svetlov at gmail.com>
date: 2018-01-30T11:34:33+02:00
summary:

bpo-32724: Fix references to commands in Doc/pdb.rst (GH-5444)

Some commands are specified in the documentation, but there is no direct
references.

files:
A Misc/NEWS.d/next/Documentation/2018-01-30-09-00-19.bpo-32724.qPIaM-.rst
M Doc/library/pdb.rst

diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index e81c195782d2..c6720cb59974 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -332,16 +332,19 @@ by the local file.
       (com) end
       (Pdb)
 
-   To remove all commands from a breakpoint, type commands and follow it
+   To remove all commands from a breakpoint, type ``commands`` and follow it
    immediately with ``end``; that is, give no commands.
 
-   With no *bpnumber* argument, commands refers to the last breakpoint set.
+   With no *bpnumber* argument, ``commands`` refers to the last breakpoint set.
 
    You can use breakpoint commands to start your program up again.  Simply use
-   the continue command, or step, or any other command that resumes execution.
+   the :pdbcmd:`continue` command, or :pdbcmd:`step`,
+   or any other command that resumes execution.
 
-   Specifying any command resuming execution (currently continue, step, next,
-   return, jump, quit and their abbreviations) terminates the command list (as if
+   Specifying any command resuming execution
+   (currently :pdbcmd:`continue`, :pdbcmd:`step`, :pdbcmd:`next`,
+   :pdbcmd:`return`, :pdbcmd:`jump`, :pdbcmd:`quit` and their abbreviations)
+   terminates the command :pdbcmd:`list` (as if
    that command was immediately followed by end). This is because any time you
    resume execution (even with a simple next or step), you may encounter another
    breakpoint—which could have its own command list, leading to ambiguities about
diff --git a/Misc/NEWS.d/next/Documentation/2018-01-30-09-00-19.bpo-32724.qPIaM-.rst b/Misc/NEWS.d/next/Documentation/2018-01-30-09-00-19.bpo-32724.qPIaM-.rst
new file mode 100644
index 000000000000..ddef6327de13
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2018-01-30-09-00-19.bpo-32724.qPIaM-.rst
@@ -0,0 +1,2 @@
+Add references to some commands in the documentation of Pdb. Patch by
+Stéphane Wirtel