Author: bugman
Date: Tue Aug 28 14:50:55 2012
New Revision: 17351
URL: http://svn.gna.org/viewcvs/relax?rev=17351&view=rev
Log:
Updates to the generic_fns.mol_res_spin.id_string_doc documentation structure.
Modified:
trunk/generic_fns/mol_res_spin.py
Modified: trunk/generic_fns/mol_res_spin.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/generic_fns/mol_res_spin.py?rev=17351&r1=17350&r2=17351&view=diff
==============================================================================
--- trunk/generic_fns/mol_res_spin.py (original)
+++ trunk/generic_fns/mol_res_spin.py Tue Aug 28 14:50:55 2012
@@ -60,8 +60,8 @@
"""The list of allowable molecule types."""
id_string_doc = Desc_container("Spin ID string documentation")
-id_string_doc.add_paragraph("The identification string is composed of three
components: the molecule id token beginning with the '#' character, the
residue id token beginning with the ':' character, and the atom or spin
system id token beginning with the '@' character. Each token can be composed
of multiple elements separated by the ',' character and each individual
element can either be a number (which must be an integer, in string format),
a name, or a range of numbers separated by the '-' character. Negative
numbers are supported. The full id string specification is '#<mol_name>
:<res_id>[, <res_id>[, <res_id>, ...]] @<atom_id>[, <atom_id>[, <atom_id>,
...]]', where the token elements are '<mol_name>', the name of the molecule,
'<res_id>', the residue identifier which can be a number, name, or range of
numbers, '<atom_id>', the atom or spin system identifier which can be a
number, name, or range of numbers.")
-id_string_doc.add_paragraph("If one of the tokens is left out then all
elements will be assumed to match. For example if the string does not
contain the '#' character then all molecules will match the string.")
+id_string_doc.add_paragraph("The identification string is composed of three
components: the molecule ID token beginning with the '#' character, the
residue ID token beginning with the ':' character, and the atom or spin
system ID token beginning with the '@' character. Each token can be composed
of multiple elements - one per spin - separated by the ',' character and each
individual element can either be a number (which must be an integer, in
string format), a name, or a range of numbers separated by the '-' character.
Negative numbers are supported. The full ID string specification is
'#<mol_name> :<res_id>[, <res_id>[, <res_id>, ...]] @<atom_id>[, <atom_id>[,
<atom_id>, ...]]', where the token elements are '<mol_name>', the name of the
molecule, '<res_id>', the residue identifier which can be a number, name, or
range of numbers, '<atom_id>', the atom or spin system identifier which can
be a number, name, or range of numbers.")
+id_string_doc.add_paragraph("If one of the tokens is left out then all
elements will be assumed to match. For example if the string does not
contain the '#' character then all molecules will match the string. If only
the molecule ID component is specified, then all spins of the molecule will
match.")
id_string_doc.add_paragraph("Regular expression can be used to select spins.
For example the string '@H*' will select the protons 'H', 'H2', 'H98'.")
r17351 - /trunk/generic_fns/mol_res_spin.py