This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: Doc: make python function/method descriptions look as in Python
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