Small fix to gdb.Value constructor doc
authorSimon Marchi <simon.marchi@efficios.com>
Tue, 5 Mar 2019 19:00:42 +0000 (14:00 -0500)
committerSimon Marchi <simon.marchi@efficios.com>
Tue, 5 Mar 2019 19:00:42 +0000 (14:00 -0500)
commitff6c8b354d853d40a4982dcf1338b9350060b75f
treec858eed7c10a44c7601db2671450c1d6ae433313
parent88c9190b4e3a177fafe1d7257ab7255542b62159
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
gdb/doc/python.texi