This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[PATCH] Small fix to gdb.Value constructor doc
- From: Simon Marchi <simon dot marchi at efficios dot com>
- To: gdb-patches at sourceware dot org
- Cc: Kevin Buettner <kevinb at redhat dot com>, Eli Zaretskii <eliz at gnu dot org>, Simon Marchi <simon dot marchi at efficios dot com>
- Date: Tue, 5 Mar 2019 12:05:44 -0500
- Subject: [PATCH] Small fix to gdb.Value constructor doc
- Dkim-filter: OpenDKIM Filter v2.10.3 mail.efficios.com D7FE9ACD69
The synopsis of the two-parameters form of the gdb.Value constructor is
currently shown as
Value.__init__ (val, [, type ])
in the documentation.
First, there is an extra comma, which I think we can remove in any
case.
Then, since the type parameter is not optional, I would not put in
between square brackets. Those usually indicate that something is
optional.
With this patch, it appears as:
Value.__init__ (val, type)
gdb/doc/ChangeLog:
* python.texi (Values From Inferior): Change synopsys of the
second form of Value.__init__.
---
gdb/doc/python.texi | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 7f6f52c4df..aaaa4ff1a6 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -735,7 +735,7 @@ its result is used.
@end table
@end defun
-@defun Value.__init__ (@var{val}, @r{[}, type @r{]})
+@defun Value.__init__ (@var{val}, type)
This second form of the @code{gdb.Value} constructor returns a
@code{gdb.Value} of type @var{type} where the value contents are taken
from the Python buffer object specified by @var{val}. The number of
--
2.21.0