r3151 - /1.3/generic_fns/pipes.py -- March 10, 2007 - 03:04

Author: bugman
Date: Sat Mar 10 03:03:28 2007
New Revision: 3151

URL: http://svn.gna.org/viewcvs/relax?rev=3151&view=rev
Log:
Updated the docstring of 'generic_fns.pipes.create' to be in Epydoc format.


Modified:
    1.3/generic_fns/pipes.py

Modified: 1.3/generic_fns/pipes.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pipes.py?rev=3151&r1=3150&r2=3151&view=diff
==============================================================================
--- 1.3/generic_fns/pipes.py (original)
+++ 1.3/generic_fns/pipes.py Sat Mar 10 03:03:28 2007
@@ -37,7 +37,18 @@
 
 
 def create(pipe_name=None, pipe_type=None):
-    """Function for creating a data pipe."""
+    """Creating a new data pipe.
+
+    @param pipe_name:   The name of the new data pipe.
+    @type pipe_name:    str
+    @param pipe_type:   The new data pipe type which can be one of the 
following:
+        'jw':  Reduced spectral density mapping,
+        'mf':  Model-free analysis,
+        'noe':  Steady state NOE calculation,
+        'relax_fit':  Relaxation curve fitting,
+        'srls':  SRLS analysis.
+    @type pipe_type:    str
+    """
 
     # Test if the data pipe already exists.
     if pipe_name in relax_data_store.pipe_names: