Re: Doc: make python function/method descriptions look as in Python

[Kevin Pouget <kevin.pouget@gmail.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