From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 8593 invoked by alias); 2 Sep 2011 16:48:31 -0000 Received: (qmail 8573 invoked by uid 22791); 2 Sep 2011 16:48:27 -0000 X-SWARE-Spam-Status: No, hits=-2.2 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from mail.codesourcery.com (HELO mail.codesourcery.com) (38.113.113.100) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Fri, 02 Sep 2011 16:48:12 +0000 Received: (qmail 5439 invoked from network); 2 Sep 2011 16:48:12 -0000 Received: from unknown (HELO scottsdale.localnet) (pedro@127.0.0.2) by mail.codesourcery.com with ESMTPA; 2 Sep 2011 16:48:12 -0000 From: Pedro Alves To: Paul_Koning@dell.com Subject: Re: Doc: make python function/method descriptions look as in Python Date: Fri, 02 Sep 2011 17:08:00 -0000 User-Agent: KMail/1.13.6 (Linux/2.6.38-11-generic; KDE/4.7.0; x86_64; ; ) Cc: gdb-patches@sourceware.org References: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM> <201109021303.53311.pedro@codesourcery.com> <09787EF419216C41A903FD14EE5506DD015343C425@AUSX7MCPC103.AMER.DELL.COM> In-Reply-To: <09787EF419216C41A903FD14EE5506DD015343C425@AUSX7MCPC103.AMER.DELL.COM> MIME-Version: 1.0 Content-Type: Text/Plain; charset="iso-8859-1" Content-Transfer-Encoding: 7bit Message-Id: <201109021748.08662.pedro@codesourcery.com> 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/msg00036.txt.bz2 On Friday 02 September 2011 16:12:39, Paul_Koning@dell.com wrote: > From: Pedro Alves [mailto:pedro@codesourcery.com] > >On Thursday 01 September 2011 21:52:59, Paul_Koning@dell.com wrote: > >>... > >> -@findex gdb.post_event > >> +@findex gdb.post_event () > >> @defun post_event event > > > >Judging from the other changes, I believe you meant to update defun instead of findex here. > > Yes, thanks. > > >IMO, it would make sense to explicit the module as well, like in the findex. 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 class name. On the other hand, the Python docs put the class name on the member name, for example http://docs.python.org/library/logging.html I'd give them the same treatment. Does @defun/@defivar/@defmethod bring in any advantage? IIUC, these are more useful for describing objects/functions in a language agnostic manner. All those "Method on Value:" look redundant to me after converting to python syntax, as it can be clearly infered from the syntax that we're talking about a method. A really-from-a-distance IMO. Don't read any of it as requirement or real review. -- Pedro Alves