This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] Small fix to gdb.Value constructor doc


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


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]