diff options
author | Tom Tromey <tromey@adacore.com> | 2024-05-21 05:13:18 -0600 |
---|---|---|
committer | Tom Tromey <tromey@adacore.com> | 2024-05-21 06:59:57 -0600 |
commit | f56e1c8c8630103a5f238645fa8be1e4802fe122 (patch) | |
tree | d0fcf47e65ae76327c7dcd7139c0f7aa9e3b4692 | |
parent | c924b84f2010d238ac86d53bad83f337e5f18f6c (diff) | |
download | gdb-f56e1c8c8630103a5f238645fa8be1e4802fe122.zip gdb-f56e1c8c8630103a5f238645fa8be1e4802fe122.tar.gz gdb-f56e1c8c8630103a5f238645fa8be1e4802fe122.tar.bz2 |
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>
-rw-r--r-- | gdb/doc/python.texi | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 4ca3ae4..86ccc14 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 |