Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: <Paul_Koning@Dell.com>
To: <eliz@gnu.org>
Cc: <gdb-patches@sourceware.org>
Subject: RE: Doc: make python function/method descriptions look as in Python
Date: Sun, 04 Sep 2011 08:38:00 -0000	[thread overview]
Message-ID: <09787EF419216C41A903FD14EE5506DD01534911A3@AUSX7MCPC103.AMER.DELL.COM> (raw)
In-Reply-To: <837h5p2a6g.fsf@gnu.org>

>> -@defun execute command [from_tty] [to_string]
>> +@defun execute (command @r{[}, from_tty @r{[}, to_string@r{]}@r{]})
>
>You can mark several `]' characters together, like this:
>
>  @defun execute (command @r{[}, from_tty @r{[}, to_string@r{]]})

Thanks, I will use that.  I'm a texinfo novice...

>> +@defmethod Value string (@r{[}encoding@r{[}, errors@r{[},
>> +length@r{]}@r{]}@r{]})
>
>You cannot break any of the @def* lines, they all must be a single line, even if it is long (here and elsewhere).

Probably my mailer linewrapping things, I'll make the proposed patch an attachment next time, or see if I can find another mail program.

>Finally, please note that the way you put the parentheses (..) in the
>@def* directives, they will be typeset in slant typeface (I think).
>So please make a PDF or PS output and eyeball it to make sure you like the result.  If you don't like it, you can use @r{(} and @r{)} like we do with square brackets.

I'll check that.  Thanks for the hint.  

	paul


  parent reply	other threads:[~2011-09-03 21:53 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
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 [this message]
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=09787EF419216C41A903FD14EE5506DD01534911A3@AUSX7MCPC103.AMER.DELL.COM \
    --to=paul_koning@dell.com \
    --cc=eliz@gnu.org \
    --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