Doc: make python function/method descriptions look as in Python
Paul_Koning@Dell.com
Paul_Koning@Dell.com
Sun Sep 4 08:38:00 GMT 2011
>> -@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
More information about the Gdb-patches
mailing list