* [PATCH] Clarify documentation for pretty_printer.child
@ 2024-05-21 11:17 Tom Tromey
2024-05-21 11:48 ` Kévin Le Gouguec
2024-05-21 12:16 ` Eli Zaretskii
0 siblings, 2 replies; 3+ messages in thread
From: Tom Tromey @ 2024-05-21 11:17 UTC (permalink / raw)
To: gdb-patches; +Cc: Tom Tromey
An Ada pretty-printer had a bug where its 'child' method returned a
gdb.Value rather than a tuple. Kévin suggested that the documentation
for this method could be improved to clarify this.
---
gdb/doc/python.texi | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 4ca3ae4eca4..86ccc140c6d 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -1869,8 +1869,9 @@ If available, this method should return the number of children.
This is not a basic method, so @value{GDBN} will only ever call it for
objects derived from @code{gdb.ValuePrinter}.
-If available, this method should return the child value indicated by
-@var{n}. Indices start at zero.
+If available, this method should return the child item (that is, a
+tuple holding the name and value of this child) indicated by @var{n}.
+Indices start at zero.
@end defun
@value{GDBN} provides a function which can be used to look up the
--
2.44.0
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Clarify documentation for pretty_printer.child
2024-05-21 11:17 [PATCH] Clarify documentation for pretty_printer.child Tom Tromey
@ 2024-05-21 11:48 ` Kévin Le Gouguec
2024-05-21 12:16 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Kévin Le Gouguec @ 2024-05-21 11:48 UTC (permalink / raw)
To: Tom Tromey; +Cc: gdb-patches
Tom Tromey <tromey@adacore.com> writes:
> An Ada pretty-printer had a bug where its 'child' method returned a
> gdb.Value rather than a tuple. Kévin suggested that the documentation
> for this method could be improved to clarify this.
> ---
> gdb/doc/python.texi | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index 4ca3ae4eca4..86ccc140c6d 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -1869,8 +1869,9 @@ If available, this method should return the number of children.
> This is not a basic method, so @value{GDBN} will only ever call it for
> objects derived from @code{gdb.ValuePrinter}.
>
> -If available, this method should return the child value indicated by
> -@var{n}. Indices start at zero.
> +If available, this method should return the child item (that is, a
> +tuple holding the name and value of this child) indicated by @var{n}.
> +Indices start at zero.
> @end defun
>
> @value{GDBN} provides a function which can be used to look up the
Thanks, I think that clear things up pretty well!
Reviewed-By: Kévin Le Gouguec <legouguec@adacore.com>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] Clarify documentation for pretty_printer.child
2024-05-21 11:17 [PATCH] Clarify documentation for pretty_printer.child Tom Tromey
2024-05-21 11:48 ` Kévin Le Gouguec
@ 2024-05-21 12:16 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2024-05-21 12:16 UTC (permalink / raw)
To: Tom Tromey; +Cc: gdb-patches
> From: Tom Tromey <tromey@adacore.com>
> Cc: Tom Tromey <tromey@adacore.com>
> Date: Tue, 21 May 2024 05:17:28 -0600
>
> An Ada pretty-printer had a bug where its 'child' method returned a
> gdb.Value rather than a tuple. Kévin suggested that the documentation
> for this method could be improved to clarify this.
> ---
> gdb/doc/python.texi | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
This is okay, thanks.
Approved-By: Eli Zaretskii <eliz@gnu.org>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-05-21 12:16 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-05-21 11:17 [PATCH] Clarify documentation for pretty_printer.child Tom Tromey
2024-05-21 11:48 ` Kévin Le Gouguec
2024-05-21 12:16 ` Eli Zaretskii
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).