From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 5567 invoked by alias); 2 Sep 2011 16:04:03 -0000 Received: (qmail 5555 invoked by uid 22791); 2 Sep 2011 16:04:02 -0000 X-SWARE-Spam-Status: No, hits=-2.0 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from ausc60ps301.us.dell.com (HELO ausc60ps301.us.dell.com) (143.166.148.206) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 02 Sep 2011 16:03:47 +0000 X-Loopcount0: from 10.170.28.39 From: To: , Date: Fri, 02 Sep 2011 16:45:00 -0000 Subject: RE: Doc: make python function/method descriptions look as in Python Message-ID: <09787EF419216C41A903FD14EE5506DD015343C425@AUSX7MCPC103.AMER.DELL.COM> References: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM> <201109021303.53311.pedro@codesourcery.com> In-Reply-To: <201109021303.53311.pedro@codesourcery.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 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-09/txt/msg00034.txt.bz2 From: Pedro Alves [mailto:pedro@codesourcery.com]=20 >On Thursday 01 September 2011 21:52:59, Paul_Koning@dell.com wrote: >>...=20 >> -@findex gdb.post_event >> +@findex gdb.post_event () >> @defun post_event event > >Judging from the other changes, I believe you meant to update defun instea= d of findex here. Yes, thanks. >IMO, it would make sense to explicit the module as well, like in the finde= x. It's how e.g., looks. Ok. What about members? They are marked as such (e.g., "instance variable= of Value" or "Method on Value") but the name itself appears without the cl= ass name. On the other hand, the Python docs put the class name on the mem= ber name, for example http://docs.python.org/library/logging.html=20 paul