r9964 - /1.3/specific_fns/api_base.py -- November 25, 2009 - 10:17

Author: bugman
Date: Wed Nov 25 10:17:49 2009
New Revision: 9964

URL: http://svn.gna.org/viewcvs/relax?rev=9964&view=rev
Log:
More docstring updates.


Modified:
    1.3/specific_fns/api_base.py

Modified: 1.3/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=9964&r1=9963&r2=9964&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Wed Nov 25 10:17:49 2009
@@ -528,6 +528,7 @@
 
         This is used for axis labelling.
 
+
         @param param:   The specific analysis parameter.
         @type param:    str
         @return:        The Grace string representation of the parameter.
@@ -541,14 +542,14 @@
     def return_units(self, param, spin=None, spin_id=None):
         """Prototype method for returning a string representing the 
parameters units.
 
-        @param param:   The name of the parameter to return the units string 
for.
-        @type param:    str
-        @param spin:    The spin container.
-        @type spin:     SpinContainer instance
-        @param spin_id: The spin identification string (ignored if the spin 
container is supplied).
-        @type spin_id:  str
-        @return:        The parameter units string.
-        @rtype:         str
+        @param param:       The name of the parameter to return the units 
string for.
+        @type param:        str
+        @keyword spin:      The spin container.
+        @type spin:         SpinContainer instance
+        @keyword spin_id:   The spin identification string (ignored if the 
spin container is supplied).
+        @type spin_id:      str
+        @return:            The parameter units string.
+        @rtype:             str
         """
 
         # Not implemented.