r20548 - /trunk/pipe_control/spectrum.py -- August 06, 2013 - 13:55

Author: bugman
Date: Tue Aug  6 13:55:40 2013
New Revision: 20548

URL: http://svn.gna.org/viewcvs/relax?rev=20548&view=rev
Log:
Epydoc docstring fix for the pipe_control.spectrum.read() function.

The text "Z_A{i}" causes problems when compiling the API documentation, so it 
has been changed to
"Z_Ai".


Modified:
    trunk/pipe_control/spectrum.py

Modified: trunk/pipe_control/spectrum.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/pipe_control/spectrum.py?rev=20548&r1=20547&r2=20548&view=diff
==============================================================================
--- trunk/pipe_control/spectrum.py (original)
+++ trunk/pipe_control/spectrum.py Tue Aug  6 13:55:40 2013
@@ -587,7 +587,7 @@
     @type spin_num_col:     int or None
     @keyword sep:           The column separator which, if None, defaults to 
whitespace.
     @type sep:              str or None
-    @keyword spin_id:       The spin ID string used to restrict data loading 
to a subset of all spins.  If 'auto' is provided for a NMRPipe seriesTab 
formatted file, the ID's are auto generated in form of Z_A{i}.
+    @keyword spin_id:       The spin ID string used to restrict data loading 
to a subset of all spins.  If 'auto' is provided for a NMRPipe seriesTab 
formatted file, the ID's are auto generated in form of Z_Ai.
     @type spin_id:          None or str
     @keyword ncproc:        The Bruker ncproc binary intensity scaling 
factor.
     @type ncproc:           int or None