Author: bugman
Date: Fri Jun 14 10:48:59 2013
New Revision: 20111
URL: http://svn.gna.org/viewcvs/relax?rev=20111&view=rev
Log:
Removed some now irrelevant information from the rdc.read user function
docstring.
Modified:
trunk/user_functions/rdc.py
Modified: trunk/user_functions/rdc.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/user_functions/rdc.py?rev=20111&r1=20110&r2=20111&view=diff
==============================================================================
--- trunk/user_functions/rdc.py (original)
+++ trunk/user_functions/rdc.py Fri Jun 14 10:48:59 2013
@@ -368,7 +368,6 @@
uf.desc[-1].add_paragraph("Internally, relax uses the D notation. Therefore
if set to '2D', the values will be doubled when read in.")
uf.desc[-1].add_paragraph("If the negative gyromagnetic ratio correction
flag is set, a sign inversion will be applied to all RDC values to be loaded.
This is sometimes needed for 15N if the data is not compensated for the
negative gyromagnetic ratio.")
uf.desc[-1].add_paragraph("The absolute RDCs flag is used for RDCs in which
the sign is unknown. All absolute RDCs loaded will be converted to positive
values.")
-uf.desc[-1].add_paragraph("The spin system can be identified in the file
using two different formats. The first is the spin ID string column which
can include the molecule name, the residue name and number, and the spin name
and number. Alternatively the molecule name, residue number and name, and
spin number and name columns can be supplied allowing this information to be
in separate columns. Note that the numbering of columns starts at one. The
spin ID can be used to restrict the reading to certain spin types, for
example only 15N spins when only residue information is in the file.")
# Prompt examples.
uf.desc.append(Desc_container("Prompt examples"))
uf.desc[-1].add_paragraph("The following commands will read the RDC data out
of the file 'Tb.txt' where the columns are separated by the symbol ',', and
store the RDCs under the ID 'Tb':")
r20111 - /trunk/user_functions/rdc.py