| Message ID | 20190305170544.23216-1-simon.marchi@efficios.com |
|---|---|
| State | New |
| Headers | show |
> From: Simon Marchi <simon.marchi@efficios.com> > Cc: Kevin Buettner <kevinb@redhat.com>, > Eli Zaretskii <eliz@gnu.org>, > Simon Marchi <simon.marchi@efficios.com> > Date: Tue, 5 Mar 2019 12:05:44 -0500 > > gdb/doc/ChangeLog: > > * python.texi (Values From Inferior): Change synopsys of the > second form of Value.__init__. Thanks, this is OK, but please take care of this gotcha: > -@defun Value.__init__ (@var{val}, @r{[}, type @r{]}) > +@defun Value.__init__ (@var{val}, type) "type" should also be in @var.
On Tue, 5 Mar 2019 12:05:44 -0500 Simon Marchi <simon.marchi@efficios.com> wrote: > 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) I agree with your changes. Thanks for fixing this! Kevin
On 2019-03-05 12:28, Eli Zaretskii wrote: >> From: Simon Marchi <simon.marchi@efficios.com> >> Cc: Kevin Buettner <kevinb@redhat.com>, >> Eli Zaretskii <eliz@gnu.org>, >> Simon Marchi <simon.marchi@efficios.com> >> Date: Tue, 5 Mar 2019 12:05:44 -0500 >> >> gdb/doc/ChangeLog: >> >> * python.texi (Values From Inferior): Change synopsys of the >> second form of Value.__init__. > > Thanks, this is OK, but please take care of this gotcha: > >> -@defun Value.__init__ (@var{val}, @r{[}, type @r{]}) >> +@defun Value.__init__ (@var{val}, type) > > "type" should also be in @var. I pushed it with this fixed. Thanks, Simon
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
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(-)