Add example of disambiguated statement to pdb docs

python · iritkatriel · May 11, 2023 · May 9, 2023 · May 9, 2023 · May 9, 2023
commit 34c84e28b595739dced6657f7d4e17b11a5a237d
@@ -602,9 +602,17 @@ can be overridden by the local file.

   Execute the (one-line) *statement* in the context of the current stack frame.
   The exclamation point can be omitted unless the first word of the statement
-   resembles a debugger command.  To set a global variable, you can prefix the
-   assignment command with a :keyword:`global` statement on the same line,
-   e.g.::
+   resembles a debugger command, e.g.:
+
+   .. code-block:: none
+
+      (Pdb) ! n=42
+      (Pdb)
+
+   To set a global variable, you can prefix the assignment command with a
+   :keyword:`global` statement on the same line, e.g.:
+
+   .. code-block:: none

      (Pdb) global list_options; list_options = ['-l']
      (Pdb)

@@ -1642,9 +1642,12 @@ def help_exec(self):

        Execute the (one-line) statement in the context of the current
        stack frame.  The exclamation point can be omitted unless the
-        first word of the statement resembles a debugger command.  To
-        assign to a global variable you must always prefix the command
-        with a 'global' command, e.g.:
+        first word of the statement resembles a debugger command, e.g.:
+        (Pdb) ! n=42
+        (Pdb)
+
+        To assign to a global variable you must always prefix the command with
+        a 'global' command, e.g.:
        (Pdb) global list_options; list_options = ['-l']
        (Pdb)
        """

diff --git a/Lib/pydoc_data/topics.py b/Lib/pydoc_data/topics.py
@@ -5283,11 +5283,14 @@
             'current\n'
             '   stack frame. The exclamation point can be omitted unless the '
             'first\n'
-             '   word of the statement resembles a debugger command.  To set '
-             'a\n'
-             '   global variable, you can prefix the assignment command with '
-             'a\n'
-             '   "global" statement on the same line, e.g.:\n'
+             '   word of the statement resembles a debugger command, e.g.:'
+             '\n'
+             '      (Pdb) ! n=42\n'
+             '      (Pdb)\n'
+             '\n'
+             '   To set a global variable, you can prefix the assignment command '
+             '   with \n'
+             '   a "global" statement on the same line, e.g.:\n'
             '\n'
             "      (Pdb) global list_options; list_options = ['-l']\n"
             '      (Pdb)\n'