r7887 - /branches/spectral_errors/prompt/spectrum.py -- October 21, 2008 - 16:38

Author: bugman
Date: Tue Oct 21 16:38:34 2008
New Revision: 7887

URL: http://svn.gna.org/viewcvs/relax?rev=7887&view=rev
Log:
Docstring updates for spectrum.read().


Modified:
    branches/spectral_errors/prompt/spectrum.py

Modified: branches/spectral_errors/prompt/spectrum.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/spectral_errors/prompt/spectrum.py?rev=7887&r1=7886&r2=7887&view=diff
==============================================================================
--- branches/spectral_errors/prompt/spectrum.py (original)
+++ branches/spectral_errors/prompt/spectrum.py Tue Oct 21 16:38:34 2008
@@ -93,11 +93,11 @@
         Keyword Arguments
         ~~~~~~~~~~~~~~~~~
 
-        file:  The name of the file containing the sequence data.
+        file:  The name of the file containing the intensity data.
 
         dir:  The directory where the file is located.
 
-        spectrum_id:  The type of spectrum.
+        spectrum_id:  The spectrum identification string.
 
         format:  The type of file containing peak intensities.
 
@@ -105,7 +105,7 @@
 
         proton:  The name of the proton as specified in the peak intensity 
file.
 
-        int_col:  The column containing the peak intensity data (for a 
non-standard formatted file).
+        int_col:  The column(s) containing the peak intensity data (for a 
non-standard formatted file).
 
 
         Description
@@ -114,9 +114,8 @@
         The peak intensity can either be from peak heights or peak volumes.
 
 
-        The 'spectrum_id' argument can have the following values:
-            'ref':  The NOE reference spectrum.
-            'sat':  The NOE spectrum with proton saturation turned on.
+        The 'spectrum_id' argument is a label which is subsequently used by 
other user functions.
+        This is a unique identifier, so the label must not already exist.
 
 
         The 'format' argument can currently be set to: