r24646 - /branches/disp_spin_speed/target_functions/relax_disp.py -- July 22, 2014 - 17:53

Author: tlinnet
Date: Tue Jul 22 17:53:47 2014
New Revision: 24646

URL: http://svn.gna.org/viewcvs/relax?rev=24646&view=rev
Log:
Documentation fix for the get_back_calc() function in 
target_function/relax_disp.py.

Task #7807 (https://gna.org/task/index.php?7807): Speed-up of dispersion 
models for Clustered analysis.

Modified:
    branches/disp_spin_speed/target_functions/relax_disp.py

Modified: branches/disp_spin_speed/target_functions/relax_disp.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/disp_spin_speed/target_functions/relax_disp.py?rev=24646&r1=24645&r2=24646&view=diff
==============================================================================
--- branches/disp_spin_speed/target_functions/relax_disp.py     (original)
+++ branches/disp_spin_speed/target_functions/relax_disp.py     Tue Jul 22 
17:53:47 2014
@@ -1793,8 +1793,8 @@
     def get_back_calc(self):
         """Class function to return back_calc as lists of lists.  Number of 
values in should match number of dispersion points or spin_lock.
 
-        @return:        back_calc in structure of list of lists.
-        @rtype:         float
+        @return:        back calculation of the R2eff/R1rho values in 
structure of list of lists.  The dimensions are {Ei, Si, Mi, Oi, Di}.
+        @rtype:         rank-4 list of numpy rank-1 float arrays
         """
 
         back_calc_return = deepcopy(self.values_orig)