r9952 - in /1.3/specific_fns: api_base.py jw_mapping.py model_free/main.py -- November 25, 2009 - 09:19

Author: bugman
Date: Wed Nov 25 09:19:52 2009
New Revision: 9952

URL: http://svn.gna.org/viewcvs/relax?rev=9952&view=rev
Log:
Docstring updates for returned values.


Modified:
    1.3/specific_fns/api_base.py
    1.3/specific_fns/jw_mapping.py
    1.3/specific_fns/model_free/main.py

Modified: 1.3/specific_fns/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=9952&r1=9951&r2=9952&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Wed Nov 25 09:19:52 2009
@@ -826,6 +826,8 @@
         @type model_info:   unknown
         @param index:       The index of the parameter to return the array 
of values for.
         @type index:        int
+        @return:            The array of simulation parameter values.
+        @rtype:             list of float
         """
 
         # Assume the default of a spin container.

Modified: 1.3/specific_fns/jw_mapping.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/jw_mapping.py?rev=9952&r1=9951&r2=9952&view=diff
==============================================================================
--- 1.3/specific_fns/jw_mapping.py (original)
+++ 1.3/specific_fns/jw_mapping.py Wed Nov 25 09:19:52 2009
@@ -500,6 +500,8 @@
         @type model_info:   SpinContainer instance
         @param index:       The index of the parameter to return the array 
of values for.
         @type index:        int
+        @return:            The array of simulation parameter values.
+        @rtype:             list of float
         """
 
         # Alias.
@@ -527,6 +529,8 @@
 
         @param model_info:  The spin container originating from model_loop().
         @type model_info:   SpinContainer instance
+        @return:            The array of selected simulation flags.
+        @rtype:             list of int
         """
 
         # Alias.

Modified: 1.3/specific_fns/model_free/main.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/model_free/main.py?rev=9952&r1=9951&r2=9952&view=diff
==============================================================================
--- 1.3/specific_fns/model_free/main.py (original)
+++ 1.3/specific_fns/model_free/main.py Wed Nov 25 09:19:52 2009
@@ -2758,6 +2758,8 @@
         @type model_info:   int
         @param index:       The index of the parameter to return the array 
of values for.
         @type index:        int
+        @return:            The array of simulation parameter values.
+        @rtype:             list of float
         """
 
         # Parameter increment counter.