FreeChainXenon/binutils-gdb
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Small fix to gdb.Value constructor doc

Browse source 
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__.
This commit is contained in:
Simon Marchi 2019-03-05 14:00:42 -05:00
parent 88c9190b4e
commit ff6c8b354d
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
gdb/doc/ChangeLog
View file

@ -1,3 +1,8 @@
2019-03-05 Simon Marchi <simon.marchi@efficios.com>
* python.texi (Values From Inferior): Change synopsys of the
second form of Value.__init__.
2019-03-02 Eli Zaretskii <eliz@gnu.org>
* gdb.texinfo (Output Styling): Fix typos. Document the default

2
gdb/doc/python.texi
View file

@ -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