r25440 - /trunk/auto_analyses/relax_disp.py -- August 29, 2014 - 16:28

Author: bugman
Date: Fri Aug 29 16:28:57 2014
New Revision: 25440

URL: http://svn.gna.org/viewcvs/relax?rev=25440&view=rev
Log:
Epydoc docstring fixes for many methods in the relaxation dispersion 
auto-analysis module.


Modified:
    trunk/auto_analyses/relax_disp.py

Modified: trunk/auto_analyses/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/auto_analyses/relax_disp.py?rev=25440&r1=25439&r2=25440&view=diff
==============================================================================
--- trunk/auto_analyses/relax_disp.py   (original)
+++ trunk/auto_analyses/relax_disp.py   Fri Aug 29 16:28:57 2014
@@ -284,7 +284,6 @@
 
         @keyword model: The model to be optimised.
         @type model:    str
-        @return:        True if the model is the more complex model in a 
nested pair and the parameters of the simpler model have been copied.  False 
otherwise.
         @return:        True if the model parameters is equivalent to the 
nested model, and all parameters are copied.  False if none or some of the 
parameters have been translated from the nested model.  Here the Grid search 
should still be performed.
         @rtype:         bool
         """
@@ -367,7 +366,7 @@
         @keyword model:         The model to be optimised.
         @type model:            str
         @keyword model_path:    The folder name for the model, where 
possible spaces has been replaced with underscore.
-        @type model:            str
+        @type model_path:       str
         """
 
         # Printout. 
@@ -534,7 +533,7 @@
         @keyword model:         The model to be optimised.
         @type model:            str
         @keyword model_path:    The folder name for the model, where 
possible spaces has been replaced with underscore.
-        @type model:            str
+        @type model_path:       str
         """
 
         # Printout.
@@ -790,7 +789,7 @@
         @keyword path:              The directory to place the files into.
         @type path:                 str
         @keyword model:             The model tested.
-        @type path:                 None or str
+        @type model:                None or str
         @keyword model_tested:      List of models tested, if the pipe is 
final.
         @type model_tested:         None or list of str.
         @keyword param:             The param to write out.