Add to documentation of Python 'dont_repeat' method
authorTom Tromey <tom@tromey.com>
Sat, 19 Feb 2022 16:33:12 +0000 (09:33 -0700)
committerTom Tromey <tom@tromey.com>
Wed, 15 Jun 2022 20:00:39 +0000 (14:00 -0600)
PR python/28533 points out that the Python 'dont_repeat' documentation
is a bit ambiguous about when the method ought to be called.  This
patch spells it out.

gdb/doc/python.texi

index 75804ef975e5165ba54a8a04be194f1356b6b977..62db5f2701685181bcc81b473a1eb5fc27bbde34 100644 (file)
@@ -4001,8 +4001,10 @@ not documented.'' is used.
 @defun Command.dont_repeat ()
 By default, a @value{GDBN} command is repeated when the user enters a
 blank line at the command prompt.  A command can suppress this
-behavior by invoking the @code{dont_repeat} method.  This is similar
-to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}.
+behavior by invoking the @code{dont_repeat} method at some point in
+its @code{invoke} method (normally this is done early in case of
+exception).  This is similar to the user command @code{dont-repeat},
+see @ref{Define, dont-repeat}.
 @end defun
 
 @defun Command.invoke (argument, from_tty)