This is the mail archive of the 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: Doc: make python function/method descriptions look as in Python

On Thu, Sep 15, 2011 at 6:12 PM,  <> 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 ?<>
> ? ? ? ?* 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.


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])



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