This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Doc: make python function/method descriptions look as in Python
- From: Kevin Pouget <kevin dot pouget at gmail dot com>
- To: Paul_Koning at dell dot com
- Cc: gdb-patches at sourceware dot org
- Date: Fri, 21 Oct 2011 15:31:37 +0200
- Subject: Re: Doc: make python function/method descriptions look as in Python
- References: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM> <837h5p2a6g.fsf@gnu.org> <09787EF419216C41A903FD14EE5506DD01534911A3@AUSX7MCPC103.AMER.DELL.COM> <E1R05Ig-00044j-Tw@fencepost.gnu.org> <09787EF419216C41A903FD14EE5506DD01534916A6@AUSX7MCPC103.AMER.DELL.COM> <09787EF419216C41A903FD14EE5506DD01534916B2@AUSX7MCPC103.AMER.DELL.COM> <7C7571B8-1AAD-4A53-BBDA-16C877DAEBBD@comcast.net> <588A138A-FF64-4214-BB1B-E5FAACD7170F@comcast.net> <8339g55shq.fsf@gnu.org> <09787EF419216C41A903FD14EE5506DD0307F9CCA9@AUSX7MCPC103.AMER.DELL.COM>
On Thu, Sep 15, 2011 at 6:12 PM, <Paul_Koning@dell.com> wrote:
> I committed this change. ?New diff attached because it changed slightly due to new methods being defined since the last edition.
>
> ? ? ? ?paul
>
> ChangeLog:
> 2011-09-15 ?Paul Koning ?<paul_koning@dell.com>
>
> ? ? ? ?* gdb.texinfo: Make style of Python functions and methods match
> ? ? ? ?the syntax of Python. ?Also put class and module names explicitly
> ? ? ? ?on function, member, and variable names, matching Python
> ? ? ? ?documentation conventions.
Hello,
I noticed a little problem with this patch (or maybe it was there
earlier, I didn't check),
with Breakpoint.__init__, the documentation looks like
> @defun Breakpoint.__init__ (spec @r{[}, type @r{[}, wp_class @r{[},internal@r{]]]})
which translate to
> Breakpoint.__init__ (spec [, type [, wp class [,internal]]])
but `internal' doesn't require `wp_class', which doesn't require
`type', do they?
I think it should rather read:
> Breakpoint.__init__ (spec [, type] [, wp class] [,internal])
Cordially,
Kevin