r20517 - /trunk/pipe_control/spectrum.py -- August 02, 2013 - 22:07

Author: bugman
Date: Fri Aug  2 22:07:49 2013
New Revision: 20517

URL: http://svn.gna.org/viewcvs/relax?rev=20517&view=rev
Log:
Added epydoc documentation in pipe_control\spectrum.py .read() when supplying 
keyword 'auto'.

Progress sr #3043: (https://gna.org/support/index.php?3043) - support for 
NMRPipe seriesTab format *.ser.

Troels E. Linnet provided this patch. Commit by: tlinnet _aaattt_ 
gmail_dot_com

Signed-off-by: Edward d'Auvergne <edward@xxxxxxxxxxxxx>

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=20517&r1=20516&r2=20517&view=diff
==============================================================================
--- trunk/pipe_control/spectrum.py (original)
+++ trunk/pipe_control/spectrum.py Fri Aug  2 22:07:49 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.
+    @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}.
     @type spin_id:          None or str
     @keyword ncproc:        The Bruker ncproc binary intensity scaling 
factor.
     @type ncproc:           int or None