r6057 - /branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py -- May 04, 2008 - 11:34

Author: bugman
Date: Sun May  4 11:34:42 2008
New Revision: 6057

URL: http://svn.gna.org/viewcvs/relax?rev=6057&view=rev
Log:
Wrote a module docstring.


Modified:
    branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py

Modified: branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py?rev=6057&r1=6056&r2=6057&view=diff
==============================================================================
--- branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py (original)
+++ branches/mol_res_spin_module_rename/generic_fns/mol_res_spin.py Sun May  
4 11:34:42 2008
@@ -20,6 +20,21 @@
 #                                                                            
 #
 
###############################################################################
 
+# Module docstring.
+"""Module for the manipulation of the molecule-residue-spin data structures 
in the relax data store.
+
+The functionality of this module is diverse:
+    - Documentation for the spin identification string.
+    - Functions for parsing or generating spin identification strings.
+    - The mol-res-spin selection object (derived from the Selection class).
+    - Generator functions for looping over molecules, residues, or spins.
+    - Functions for returning MoleculeContainer, ResidueContainer, and 
SpinContainer objects or
+    information about these.
+    - Functions for copying, creating, deleting, displaying, naming, and 
numbering
+    MoleculeContainer, ResidueContainer, and SpinContainer objects in the 
relax data store.
+    - Functions for counting spins or testing their existence.
+"""
+
 # Python module imports.
 from os import F_OK, access
 from re import compile, match, search, split