From: Tom Tromey Date: Tue, 21 May 2024 11:13:18 +0000 (-0600) Subject: Clarify documentation for pretty_printer.child X-Git-Tag: gdb-15-branchpoint~28 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f56e1c8c8630103a5f238645fa8be1e4802fe122;p=thirdparty%2Fbinutils-gdb.git 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 Approved-By: Eli Zaretskii --- 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