From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 11136 invoked by alias); 21 Oct 2011 13:32:15 -0000 Received: (qmail 11122 invoked by uid 22791); 21 Oct 2011 13:32:13 -0000 X-SWARE-Spam-Status: No, hits=-2.2 required=5.0 tests=AWL,BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,T_TO_NO_BRKTS_FREEMAIL X-Spam-Check-By: sourceware.org Received: from mail-vx0-f169.google.com (HELO mail-vx0-f169.google.com) (209.85.220.169) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 21 Oct 2011 13:31:58 +0000 Received: by vcbfk1 with SMTP id fk1so4366197vcb.0 for ; Fri, 21 Oct 2011 06:31:57 -0700 (PDT) Received: by 10.220.151.19 with SMTP id a19mr1073655vcw.87.1319203917234; Fri, 21 Oct 2011 06:31:57 -0700 (PDT) MIME-Version: 1.0 Received: by 10.220.180.75 with HTTP; Fri, 21 Oct 2011 06:31:37 -0700 (PDT) In-Reply-To: <09787EF419216C41A903FD14EE5506DD0307F9CCA9@AUSX7MCPC103.AMER.DELL.COM> References: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM> <837h5p2a6g.fsf@gnu.org> <09787EF419216C41A903FD14EE5506DD01534911A3@AUSX7MCPC103.AMER.DELL.COM> <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> From: Kevin Pouget Date: Fri, 21 Oct 2011 14:17:00 -0000 Message-ID: Subject: Re: Doc: make python function/method descriptions look as in Python To: Paul_Koning@dell.com Cc: gdb-patches@sourceware.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2011-10/txt/msg00592.txt.bz2 On Thu, Sep 15, 2011 at 6:12 PM, wrote: > I committed this change. =A0New diff attached because it changed slightly= due to new methods being defined since the last edition. > > =A0 =A0 =A0 =A0paul > > ChangeLog: > 2011-09-15 =A0Paul Koning =A0 > > =A0 =A0 =A0 =A0* gdb.texinfo: Make style of Python functions and methods = match > =A0 =A0 =A0 =A0the syntax of Python. =A0Also put class and module names e= xplicitly > =A0 =A0 =A0 =A0on function, member, and variable names, matching Python > =A0 =A0 =A0 =A0documentation 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{[},intern= al@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