r22991 - in /trunk/specific_analyses: api_base.py relax_disp/api.py -- May 05, 2014 - 23:04

Author: bugman
Date: Mon May  5 23:04:28 2014
New Revision: 22991

URL: http://svn.gna.org/viewcvs/relax?rev=22991&view=rev
Log:
Docsting fixes for some model_statistics() API methods, including the base 
class method.


Modified:
    trunk/specific_analyses/api_base.py
    trunk/specific_analyses/relax_disp/api.py

Modified: trunk/specific_analyses/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/api_base.py?rev=22991&r1=22990&r2=22991&view=diff
==============================================================================
--- trunk/specific_analyses/api_base.py (original)
+++ trunk/specific_analyses/api_base.py Mon May  5 23:04:28 2014
@@ -418,9 +418,9 @@
         chi2 - the chi-squared value.
 
 
-        @keyword model_info:    The model index from model_info().
-        @type model_info:       None or int
-        @keyword spin_id:       The spin identification string.  This is 
ignored in the N-state model.
+        @keyword model_info:    The model information originating from 
model_loop().
+        @type model_info:       unknown
+        @keyword spin_id:       The spin ID string to override the 
model_info argument.  This is ignored in the N-state model.
         @type spin_id:          None or str
         @keyword global_stats:  A parameter which determines if global or 
local statistics are returned.  For the N-state model, this argument is 
ignored.
         @type global_stats:     None or bool

Modified: trunk/specific_analyses/relax_disp/api.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_disp/api.py?rev=22991&r1=22990&r2=22991&view=diff
==============================================================================
--- trunk/specific_analyses/relax_disp/api.py   (original)
+++ trunk/specific_analyses/relax_disp/api.py   Mon May  5 23:04:28 2014
@@ -668,9 +668,9 @@
         chi2 - the chi-squared value.
 
 
-        @keyword model_info:    The model index from model_info().
-        @type model_info:       None or int
-        @keyword spin_id:       The spin identification string.  This is 
ignored in the N-state model.
+        @keyword model_info:    The model information originating from 
model_loop().
+        @type model_info:       unknown
+        @keyword spin_id:       The spin ID string to override the 
model_info argument.  This is ignored in the N-state model.
         @type spin_id:          None or str
         @keyword global_stats:  A parameter which determines if global or 
local statistics are returned.  For the N-state model, this argument is 
ignored.
         @type global_stats:     None or bool