[PATCH] Clarify documentation for pretty_printer.child

[PATCH] Clarify documentation for pretty_printer.child

[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

Re: [PATCH] Clarify documentation for pretty_printer.child

[Kévin Le Gouguec]

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>

Re: [PATCH] Clarify documentation for pretty_printer.child

[Eli Zaretskii]

> 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>