r15854 - /1.3/prompt/bruker.py -- April 30, 2012 - 14:40

Author: bugman
Date: Mon Apr 30 13:15:48 2012
New Revision: 15854

URL: http://svn.gna.org/viewcvs/relax?rev=15854&view=rev
Log:
Improved the bruker.read user function docstring.


Modified:
    1.3/prompt/bruker.py

Modified: 1.3/prompt/bruker.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/bruker.py?rev=15854&r1=15853&r2=15854&view=diff
==============================================================================
--- 1.3/prompt/bruker.py (original)
+++ 1.3/prompt/bruker.py Mon Apr 30 13:15:48 2012
@@ -51,15 +51,15 @@
         bruker.read(ri_id=ri_id, file=file, dir=dir)
 
     # The function doc info.
-    read._doc_title = "Read a Bruker Dynamics Center (DC) file."
-    read._doc_title_short = "Reading a Bruker Dynamics Center file."
+    read._doc_title = "Read a Bruker Dynamics Center (DC) relaxation data 
file."
+    read._doc_title_short = "Read a Bruker Dynamics Center file."
     read._doc_args = [
         ["ri_id", "The relaxation data ID string.  This must be a unique 
identifier."],
         ["file", "The name of the Bruker Dynamics Center file containing the 
relaxation data."],
         ["dir", "The directory where the file is located."],
     ]
     read._doc_desc = """
-        This user function is used to load all of the data out of a Bruker 
Dynamics Center (DC) file for subsequent analysis within relax.
+        This user function is used to load all of the data out of a Bruker 
Dynamics Center (DC) relaxation data file for subsequent analysis within 
relax.  Currently the R1 and R2 relaxation rates and steady-state NOE data is 
supported.
         """
     _build_doc(read)