[pushed/obv] DOC: Add space before the opening parenthesis in function descriptions

[pushed/obv] DOC: Add space before the opening parenthesis in function descriptions

[Siva Chandra]

[-- Attachment #1: Type: text/plain, Size: 175 bytes --]

doc/
2014-06-09  Siva Chandra Reddy  <sivachandra@google.com>

        * python.texi (Xmethod API): Add space before the opening
        parenthesis in function descriptions.

[-- Attachment #2: obv_fix_xmethod_doc.txt --]
[-- Type: text/plain, Size: 2535 bytes --]

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 2f1b71f..4688783 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -2270,7 +2270,7 @@ disabled.
 The class @code{XMethod} is a convenience class with same
 attributes as above along with the following constructor:
 
-@defun XMethod.__init__(self, name)
+@defun XMethod.__init__ (self, name)
 Constructs an enabled xmethod with name @var{name}.
 @end defun
 @end defvar
@@ -2278,12 +2278,12 @@ Constructs an enabled xmethod with name @var{name}.
 @noindent
 The @code{XMethodMatcher} class has the following methods:
 
-@defun XMethodMatcher.__init__(self, name)
+@defun XMethodMatcher.__init__ (self, name)
 Constructs an enabled xmethod matcher with name @var{name}.  The
 @code{methods} attribute is initialized to @code{None}.
 @end defun
 
-@defun XMethodMatcher.match(self, class_type, method_name)
+@defun XMethodMatcher.match (self, class_type, method_name)
 Derived classes should override this method.  It should return a
 xmethod worker object (or a sequence of xmethod worker
 objects) matching the @var{class_type} and @var{method_name}.
@@ -2298,7 +2298,7 @@ An xmethod worker should be an instance of a class derived from
 @code{XMethodWorker} defined in the module @code{gdb.xmethod},
 or support the following interface:
 
-@defun XMethodWorker.get_arg_types(self)
+@defun XMethodWorker.get_arg_types (self)
 This method returns a sequence of @code{gdb.Type} objects corresponding
 to the arguments that the xmethod takes.  It can return an empty
 sequence or @code{None} if the xmethod does not take any arguments.
@@ -2306,7 +2306,7 @@ If the xmethod takes a single argument, then a single
 @code{gdb.Type} object corresponding to it can be returned.
 @end defun
 
-@defun XMethodWorker.__call__(self, *args)
+@defun XMethodWorker.__call__ (self, *args)
 This is the method which does the @emph{work} of the xmethod.  The
 @var{args} arguments is the tuple of arguments to the xmethod.  Each
 element in this tuple is a gdb.Value object.  The first element is
@@ -2317,7 +2317,7 @@ For @value{GDBN} to lookup xmethods, the xmethod matchers
 should be registered using the following function defined in the module
 @code{gdb.xmethod}:
 
-@defun register_xmethod_matcher(locus, matcher, replace=False)
+@defun register_xmethod_matcher (locus, matcher, replace=False)
 The @code{matcher} is registered with @code{locus}, replacing an
 existing matcher with the same name as @code{matcher} if
 @code{replace} is @code{True}.  @code{locus} can be a

Re: [pushed/obv] DOC: Add space before the opening parenthesis in function descriptions

[Eli Zaretskii]

> Date: Mon, 9 Jun 2014 07:23:27 -0700
> From: Siva Chandra <sivachandra@google.com>
> 
> doc/
> 2014-06-09  Siva Chandra Reddy  <sivachandra@google.com>
> 
>         * python.texi (Xmethod API): Add space before the opening
>         parenthesis in function descriptions.

Thanks.  As luck would have it, I also bumped into this today.

Re: [pushed/obv] DOC: Add space before the opening parenthesis in function descriptions

[Joel Brobecker]

> 2014-06-09  Siva Chandra Reddy  <sivachandra@google.com>
> 
>         * python.texi (Xmethod API): Add space before the opening
>         parenthesis in function descriptions.

> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index 2f1b71f..4688783 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -2270,7 +2270,7 @@ disabled.
>  The class @code{XMethod} is a convenience class with same
>  attributes as above along with the following constructor:
>  
> -@defun XMethod.__init__(self, name)
> +@defun XMethod.__init__ (self, name)

Should we NOT put a space there? The recommendation for Python
code is to not have spaces before parens (see PEP8).

-- 
Joel

Re: [pushed/obv] DOC: Add space before the opening parenthesis in function descriptions

[Eli Zaretskii]

> Date: Mon, 9 Jun 2014 17:15:06 +0200
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb-patches <gdb-patches@sourceware.org>
> 
> > -@defun XMethod.__init__(self, name)
> > +@defun XMethod.__init__ (self, name)
> 
> Should we NOT put a space there? The recommendation for Python
> code is to not have spaces before parens (see PEP8).

This is not python, this is Texinfo.  It complains when you don't have
whitespace there (I think because it must know where the identifier
ends, to index it).