r8144 - /1.3/prompt/noe.py -- December 05, 2008 - 14:35

Author: bugman
Date: Fri Dec  5 14:35:55 2008
New Revision: 8144

URL: http://svn.gna.org/viewcvs/relax?rev=8144&view=rev
Log:
Modified the noe.spectrum_type() docstring to emphasis that it is for the 
steady-state NOE.


Modified:
    1.3/prompt/noe.py

Modified: 1.3/prompt/noe.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/noe.py?rev=8144&r1=8143&r2=8144&view=diff
==============================================================================
--- 1.3/prompt/noe.py (original)
+++ 1.3/prompt/noe.py Fri Dec  5 14:35:55 2008
@@ -47,12 +47,12 @@
 
 
     def spectrum_type(self, spectrum_type=None, spectrum_id=None):
-        """Function for setting the spectrum type for pre-loaded peak 
intensities.
+        """Set the steady-state NOE spectrum type for pre-loaded peak 
intensities.
 
         Keyword Arguments
         ~~~~~~~~~~~~~~~~~
 
-        spectrum_type:  The type of NOE spectrum, one of 'ref' or 'sat'.
+        spectrum_type:  The type of steady-state NOE spectrum, one of 'ref' 
or 'sat'.
 
         spectrum_id:  The spectrum identification string.
 
@@ -61,8 +61,8 @@
         ~~~~~~~~~~~
 
         The spectrum_type argument can have the following values:
-            'ref':  The NOE reference spectrum.
-            'sat':  The NOE spectrum with proton saturation turned on.
+            'ref':  The steady-state NOE reference spectrum.
+            'sat':  The steady-state NOE spectrum with proton saturation 
turned on.
 
         Peak intensities should be loaded before calling this user function 
via the
         'spectrum.read_intensities()' user function.  The intensity values 
will then be associated