]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commitdiff
Clarify documentation for pretty_printer.child
authorTom Tromey <tromey@adacore.com>
Tue, 21 May 2024 11:13:18 +0000 (05:13 -0600)
committerTom Tromey <tromey@adacore.com>
Tue, 21 May 2024 12:59:57 +0000 (06:59 -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.

Reviewed-By: Kévin Le Gouguec <legouguec@adacore.com>
Approved-By: Eli Zaretskii <eliz@gnu.org>
gdb/doc/python.texi

index 4ca3ae4eca4c17bec51ebcc5b10214224512e17b..86ccc140c6de2ea8d40208bd8867ce080ce49fef 100644 (file)
@@ -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