r15425 - in /1.3: ./ generic_fns/ generic_fns/structure/ gui/ multi/ -- March 01, 2012 - 14:28

Author: bugman
Date: Thu Mar  1 14:28:41 2012
New Revision: 15425

URL: http://svn.gna.org/viewcvs/relax?rev=15425&view=rev
Log:
Epydoc docstring fixes.


Modified:
    1.3/generic_fns/align_tensor.py
    1.3/generic_fns/structure/superimpose.py
    1.3/gui/interpreter.py
    1.3/multi/processor.py
    1.3/relax_io.py

Modified: 1.3/generic_fns/align_tensor.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/align_tensor.py?rev=15425&r1=15424&r2=15425&view=diff
==============================================================================
--- 1.3/generic_fns/align_tensor.py (original)
+++ 1.3/generic_fns/align_tensor.py Thu Mar  1 14:28:41 2012
@@ -1045,7 +1045,7 @@
     """Count the number of tensors.
 
     @keyword skip_fixed:    If set to True, then only the tensors without 
the fixed flag will be counted.  If set to False, then all tensors will be 
counted.
-    @type fixed:            bool
+    @type skip_fixed:       bool
     @return:                The number of tensors (excluding fixed tensors 
by default).
     @rtype:                 int
     """

Modified: 1.3/generic_fns/structure/superimpose.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/superimpose.py?rev=15425&r1=15424&r2=15425&view=diff
==============================================================================
--- 1.3/generic_fns/structure/superimpose.py (original)
+++ 1.3/generic_fns/structure/superimpose.py Thu Mar  1 14:28:41 2012
@@ -118,7 +118,7 @@
     @keyword coord:     The list of coordinates of all models to 
superimpose.  The first index is the models, the second is the atomic 
positions, and the third is the xyz coordinates.
     @type coord:        list of numpy rank-2, Nx3 arrays
     @keyword mean:      The data storage for the mean structure.
-    @type coord:        numpy rank-2, Nx3 array
+    @type mean:         numpy rank-2, Nx3 array
     """
 
     # The number of atoms.

Modified: 1.3/gui/interpreter.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/gui/interpreter.py?rev=15425&r1=15424&r2=15425&view=diff
==============================================================================
--- 1.3/gui/interpreter.py (original)
+++ 1.3/gui/interpreter.py Thu Mar  1 14:28:41 2012
@@ -273,8 +273,8 @@
     def queue(self, fn, *args, **kwds):
         """Queue up a user function for asynchronous execution.
 
-        @param uf:      The user function as a string.
-        @type uf:       str
+        @param fn:      The user function as a string.
+        @type fn:       str
         @param args:    The user function arguments.
         @type args:     any arguments
         @param kwds:    The user function keyword arguments.

Modified: 1.3/multi/processor.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/multi/processor.py?rev=15425&r1=15424&r2=15425&view=diff
==============================================================================
--- 1.3/multi/processor.py (original)
+++ 1.3/multi/processor.py Thu Mar  1 14:28:41 2012
@@ -148,7 +148,7 @@
         self.callback = callback
         """Callback to interface to the host application
 
-        @see Application_callback."""
+        @see:  Application_callback."""
 
         self.grainyness = 1
         """The number of sub jobs to queue for each processor if we have 
more jobs than processors."""

Modified: 1.3/relax_io.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/relax_io.py?rev=15425&r1=15424&r2=15425&view=diff
==============================================================================
--- 1.3/relax_io.py (original)
+++ 1.3/relax_io.py Thu Mar  1 14:28:41 2012
@@ -621,7 +621,6 @@
     @keyword comments:  A flag which if True will cause comments to be 
deleted.
     @type comments:     bool
     @return:            The input data with the empty and comment lines 
removed.
-    @return:            The file data with comment and empty lines removed.
     @rtype:             list of lists of str
     """