Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Pedro Alves <pedro@codesourcery.com>
To: gdb-patches@sourceware.org
Cc: Paul_Koning@dell.com
Subject: Re: Doc: make python function/method descriptions look as in Python
Date: Fri, 02 Sep 2011 12:26:00 -0000	[thread overview]
Message-ID: <201109021303.53311.pedro@codesourcery.com> (raw)
In-Reply-To: <09787EF419216C41A903FD14EE5506DD015343BFAE@AUSX7MCPC103.AMER.DELL.COM>

On Thursday 01 September 2011 21:52:59, Paul_Koning@dell.com wrote:
>  @findex gdb.parse_and_eval
> -@defun parse_and_eval expression
> +@defun parse_and_eval (expression)
>  Parse @var{expression} as an expression in the current language,  evaluate it, and return the result as a @code{gdb.Value}.
>  @var{expression} must be a string.
> @@ -21070,7 +21070,7 @@
>  convenience variable (@pxref{Convenience Vars}) as a @code{gdb.Value}.
>  @end defun
> 
> -@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.

IMO, it would make sense to explicit the module as well, like
in the findex.  It's how e.g.,
<http://docs.python.org/library/time.html> looks.

-- 
Pedro Alves


  reply	other threads:[~2011-09-02 12:04 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-09-01 21:23 Paul_Koning
2011-09-02 12:26 ` Pedro Alves [this message]
2011-09-02 16:45   ` Paul_Koning
2011-09-02 17:08     ` Pedro Alves
2011-09-03 19:46 ` Eli Zaretskii
2011-09-03 21:53   ` Matt Rice
2011-09-04  8:38   ` Paul_Koning
2011-09-04 10:37     ` Eli Zaretskii
2011-09-06 15:42       ` Paul_Koning
     [not found]         ` <09787EF419216C41A903FD14EE5506DD01534916B2@AUSX7MCPC103.AMER.DELL.COM>
2011-09-06 18:01           ` Paul Koning
2011-09-09 21:15             ` Paul Koning
2011-09-09 21:33               ` Eli Zaretskii
2011-09-15 17:19                 ` Paul_Koning
2011-10-21 14:17                   ` Kevin Pouget
2011-10-21 15:51                     ` Tom Tromey
2011-09-06 19:39         ` Phil Muldoon
2011-09-06 19:45           ` Paul_Koning
2011-09-06 19:57             ` Paul_Koning
2011-09-06 20:07             ` Eli Zaretskii
2011-09-06 20:25               ` Paul_Koning
2011-09-07  0:45                 ` Eli Zaretskii
2011-09-06 19:56           ` Eli Zaretskii
2011-09-06 20:01             ` Paul_Koning

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201109021303.53311.pedro@codesourcery.com \
    --to=pedro@codesourcery.com \
    --cc=Paul_Koning@dell.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox