r13561 - /branches/gui_testing/prompt/spectrum.py -- July 12, 2011 - 18:02

Author: bugman
Date: Tue Jul 12 18:02:09 2011
New Revision: 13561

URL: http://svn.gna.org/viewcvs/relax?rev=13561&view=rev
Log:
Docstring updates for the spectrum.replicated user function.


Modified:
    branches/gui_testing/prompt/spectrum.py

Modified: branches/gui_testing/prompt/spectrum.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/gui_testing/prompt/spectrum.py?rev=13561&r1=13560&r2=13561&view=diff
==============================================================================
--- branches/gui_testing/prompt/spectrum.py (original)
+++ branches/gui_testing/prompt/spectrum.py Tue Jul 12 18:02:09 2011
@@ -302,13 +302,13 @@
         spectrum.replicated(spectrum_ids=spectrum_ids)
 
     # The function doc info.
-    replicated._doc_title = "Specify which spectra are replicates."
+    replicated._doc_title = "Specify which spectra are replicates of each 
other."
     replicated._doc_title_short = "Replicate spectra."
     replicated._doc_args = [
         ["spectrum_ids", "The list of replicated spectra ID strings."]
     ]
     replicated._doc_desc = """
-        This is used to identify which loaded spectra are replicates of each 
other.  This is very important for error analysis.
+        This is used to identify which of the loaded spectra are replicates 
of each other.  Specifying the replicates is essential for error analysis if 
the baseplane RMSD has not been supplied.
         """
     replicated._doc_examples = """
         To specify that the NOE spectra labelled 'ref1', 'ref2', and 'ref3' 
are the same spectrum