r4280 - in /1.3/specific_fns: base_class.py model_free/model_free.py -- January 03, 2008 - 17:28

Author: bugman
Date: Thu Jan  3 17:28:19 2008
New Revision: 4280

URL: http://svn.gna.org/viewcvs/relax?rev=4280&view=rev
Log:
Updated the docstrings for epydoc for the set() and set_update() class 
methods recently updated.


Modified:
    1.3/specific_fns/base_class.py
    1.3/specific_fns/model_free/model_free.py

Modified: 1.3/specific_fns/base_class.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/base_class.py?rev=4280&r1=4279&r2=4280&view=diff
==============================================================================
--- 1.3/specific_fns/base_class.py (original)
+++ 1.3/specific_fns/base_class.py Thu Jan  3 17:28:19 2008
@@ -143,7 +143,19 @@
 
 
     def set(self, value=None, error=None, param=None, scaling=1.0, 
spin=None):
-        """Common function for setting parameter values."""
+        """Common function for setting parameter values.
+
+        @param value:   The value to change the parameter to.
+        @type value:    float
+        @param error:   The error value associated with the parameter, also 
to be set.
+        @type error:    float
+        @param param:   The name of the parameter to change.
+        @type param:    str
+        @param scaling: The scaling factor for the value or error parameters.
+        @type scaling:  float
+        @param spin:    The SpinContainer object.
+        @type spin:     SpinContainer
+        """
 
         # Setting the model parameters prior to minimisation.
         #####################################################
@@ -237,7 +249,13 @@
 
 
     def set_update(self, param, spin):
-        """Dummy function to do nothing!"""
+        """Dummy function to do nothing!
+
+        @param param:   The name of the parameter which has been changed.
+        @type param:    str
+        @param spin:    The SpinContainer object.
+        @type spin:     SpinContainer
+        """
 
         return
 

Modified: 1.3/specific_fns/model_free/model_free.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/model_free/model_free.py?rev=4280&r1=4279&r2=4280&view=diff
==============================================================================
--- 1.3/specific_fns/model_free/model_free.py (original)
+++ 1.3/specific_fns/model_free/model_free.py Thu Jan  3 17:28:19 2008
@@ -4172,7 +4172,13 @@
 
 
     def set_update(self, param, spin):
-        """Function to update the other model-free parameters."""
+        """Function to update the other model-free parameters.
+
+        @param param:   The name of the parameter which has been changed.
+        @type param:    str
+        @param spin:    The SpinContainer object.
+        @type spin:     SpinContainer
+        """
 
         # S2f parameter.
         if param == 'S2f':