From ff6c8b354d853d40a4982dcf1338b9350060b75f Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Tue, 5 Mar 2019 14:00:42 -0500 Subject: [PATCH] Small fix to gdb.Value constructor doc 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/ChangeLog | 5 +++++ gdb/doc/python.texi | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index 6e95f93b656..0380322dfee 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2019-03-05 Simon Marchi + + * python.texi (Values From Inferior): Change synopsys of the + second form of Value.__init__. + 2019-03-02 Eli Zaretskii * gdb.texinfo (Output Styling): Fix typos. Document the default diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 7f6f52c4df6..b02a154ce1b 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}, @var{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.30.2