r22742 - in /trunk: specific_analyses/consistency_tests/ user_functions/ -- April 14, 2014 - 17:53

Author: bugman
Date: Mon Apr 14 17:53:03 2014
New Revision: 22742

URL: http://svn.gna.org/viewcvs/relax?rev=22742&view=rev
Log:
The consistency testing parameter setting documentation has been shifted into 
the parameter list object.

This has also been updated to reflect the current design of relax.


Modified:
    trunk/specific_analyses/consistency_tests/parameter_object.py
    trunk/specific_analyses/consistency_tests/uf.py
    trunk/user_functions/value.py

Modified: trunk/specific_analyses/consistency_tests/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/consistency_tests/parameter_object.py?rev=22742&r1=22741&r2=22742&view=diff
==============================================================================
--- trunk/specific_analyses/consistency_tests/parameter_object.py       
(original)
+++ trunk/specific_analyses/consistency_tests/parameter_object.py       Mon 
Apr 14 17:53:03 2014
@@ -57,3 +57,7 @@
         self._set_uf_title("Consistency testing parameters")
         self._uf_param_table(label="table: consistency testing parameters", 
caption="Consistency testing parameters.")
         self._uf_param_table(label="table: consistency testing parameter 
value setting", caption="Consistency testing parameter value setting.", 
default=True)
+
+        # Value setting documentation.
+        for doc in self._uf_doc_loop(["table: consistency testing 
parameters", "table: consistency testing parameter value setting"]):
+            doc.add_paragraph("In consistency testing, the CSA value, angle 
Theta ('orientation') and global correlation time must be set prior to the 
calculation of consistency functions.")

Modified: trunk/specific_analyses/consistency_tests/uf.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/consistency_tests/uf.py?rev=22742&r1=22741&r2=22742&view=diff
==============================================================================
--- trunk/specific_analyses/consistency_tests/uf.py     (original)
+++ trunk/specific_analyses/consistency_tests/uf.py     Mon Apr 14 17:53:03 
2014
@@ -32,11 +32,6 @@
 from user_functions.objects import Desc_container
 
 
-# Value setting documentation.
-set_doc = Desc_container("Consistency testing set details")
-set_doc.add_paragraph("In consistency testing, only four values can be set, 
the bond length, CSA, angle Theta ('orientation') and correlation time 
values. These must be set prior to the calculation of consistency functions.")
-
-
 def set_frq(frq=None):
     """Function for selecting which relaxation data to use in the 
consistency tests."""
 

Modified: trunk/user_functions/value.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22742&r1=22741&r2=22742&view=diff
==============================================================================
--- trunk/user_functions/value.py       (original)
+++ trunk/user_functions/value.py       Mon Apr 14 17:53:03 2014
@@ -99,7 +99,6 @@
 uf.desc.append(regexp_doc)
 uf.desc.append(model_free_params.uf_doc(label="table: model-free 
parameters"))
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
-uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameters"))
 uf.desc.append(relax_fit_uf.set_doc)
 uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
@@ -288,7 +287,6 @@
 uf.desc.append(regexp_doc)
 uf.desc.append(model_free_params.uf_doc(label="table: model-free 
parameters"))
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
-uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameters"))
 uf.desc.append(relax_fit_uf.set_doc)
 uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameters"))
@@ -378,7 +376,6 @@
 uf.desc.append(diffusion_tensor.__set_doc__)
 uf.desc.append(model_free_params.uf_doc(label="table: mf parameter value 
setting"))
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameter value 
setting"))
-uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameter value setting"))
 uf.desc.append(relax_fit_uf.set_doc)
 uf.desc.append(relax_fit_params.uf_doc(label="table: curve-fit parameter 
value setting"))