Clarify documentation for pretty_printer.child

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>
This commit is contained in:
Tom Tromey 2024-05-21 05:13:18 -06:00
parent c924b84f20
commit f56e1c8c86

View 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