r13529 - /branches/gui_testing/specific_fns/jw_mapping.py -- July 08, 2011 - 12:02

Author: bugman
Date: Fri Jul  8 12:02:56 2011
New Revision: 13529

URL: http://svn.gna.org/viewcvs/relax?rev=13529&view=rev
Log:
Converted all of the J(w) mapping documentation used in the user functions to 
the new design.


Modified:
    branches/gui_testing/specific_fns/jw_mapping.py

Modified: branches/gui_testing/specific_fns/jw_mapping.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/gui_testing/specific_fns/jw_mapping.py?rev=13529&r1=13528&r2=13529&view=diff
==============================================================================
--- branches/gui_testing/specific_fns/jw_mapping.py (original)
+++ branches/gui_testing/specific_fns/jw_mapping.py Fri Jul  8 12:02:56 2011
@@ -259,9 +259,7 @@
         return names
 
 
-    default_value_doc = """
-        Reduced spectral density mapping default values
-        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    default_value_doc = ["Reduced spectral density mapping default values", 
"""
         These default values are found in the file 'physical_constants.py'.
 
         
_______________________________________________________________________________________
@@ -278,7 +276,7 @@
         | Proton type                           | 'proton_type'      | '1H'  
                 |
         
|_______________________________________|____________________|________________________|
 
-        """
+        """]
 
     def default_value(self, param):
         """The default J(w) mapping parameter values.
@@ -329,10 +327,7 @@
                 spin.select = False
 
 
-    return_data_name_doc = """
-        Reduced spectral density mapping data type string matching patterns
-        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+    return_data_name_doc = ["Reduced spectral density mapping data type 
string matching patterns", """
         
____________________________________________________________________________________________
         |                        |                  |                        
                      |
         | Data type              | Object name      | Patterns               
                      |
@@ -353,7 +348,7 @@
         | Proton type            | 'proton_type'    | '^[Pp]roton$'          
                      |
         
|________________________|__________________|______________________________________________|
 
-        """
+        """]
 
     def return_data_name(self, param):
         """Return a unique identifying string for the J(w) mapping parameter.
@@ -457,13 +452,9 @@
             return 'ppm'
 
 
-    set_doc = """
-        Reduced spectral density mapping set details
-        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-        In reduced spectral density mapping, three values must be set prior 
to the calculation of
-        spectral density values:  the bond length, CSA, and heteronucleus 
type.
-        """
+    set_doc = ["Reduced spectral density mapping set details", """
+        In reduced spectral density mapping, three values must be set prior 
to the calculation of spectral density values:  the bond length, CSA, and 
heteronucleus type.
+        """]
 
 
     def set_error(self, model_info, index, error):