[PATCH] Add to documentation of Python 'dont_repeat' method

[PATCH] Add to documentation of Python 'dont_repeat' method

[Tom Tromey]

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 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index c1a3f5f2a7e..c861bc34fd3 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3896,8 +3896,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)
-- 
2.31.1

Re: [PATCH] Add to documentation of Python 'dont_repeat' method

[Tom Tromey]

>>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:

Tom> PR python/28533 points out that the Python 'dont_repeat' documentation
Tom> is a bit ambiguous about when the method ought to be called.  This
Tom> patch spells it out.

Ping.

Tom

Re: [PATCH] Add to documentation of Python 'dont_repeat' method

[Tom Tromey]

>>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:

>>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:
Tom> PR python/28533 points out that the Python 'dont_repeat' documentation
Tom> is a bit ambiguous about when the method ought to be called.  This
Tom> patch spells it out.

> Ping.

Ping again.

Tom

Re: [PATCH] Add to documentation of Python 'dont_repeat' method

[Christian Biesinger]

On Wed, Jun 15, 2022 at 11:45 AM Tom Tromey <tom@tromey.com> wrote:
>
> >>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:
>
> >>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:
> Tom> PR python/28533 points out that the Python 'dont_repeat' documentation
> Tom> is a bit ambiguous about when the method ought to be called.  This
> Tom> patch spells it out.
>
> > Ping.
>
> Ping again.

FWIW I like this change.

Christian

Re: [PATCH] Add to documentation of Python 'dont_repeat' method

[Eli Zaretskii]

> From: Tom Tromey <tom@tromey.com>
> Date: Wed, 15 Jun 2022 09:45:05 -0600
> Cc: gdb-patches@sourceware.org
> 
> >>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:
> 
> >>>>> "Tom" == Tom Tromey <tom@tromey.com> writes:
> Tom> PR python/28533 points out that the Python 'dont_repeat' documentation
> Tom> is a bit ambiguous about when the method ought to be called.  This
> Tom> patch spells it out.
> 
> > Ping.
> 
> Ping again.

Sorry for missing it.

This is OK, Texinfo-wise.