r5852 - /1.3/generic_fns/structure/scientific.py -- April 20, 2008 - 18:11

Author: bugman
Date: Sun Apr 20 18:11:54 2008
New Revision: 5852

URL: http://svn.gna.org/viewcvs/relax?rev=5852&view=rev
Log:
Docstring fix for the __residue_loop() method.


Modified:
    1.3/generic_fns/structure/scientific.py

Modified: 1.3/generic_fns/structure/scientific.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/scientific.py?rev=5852&r1=5851&r2=5852&view=diff
==============================================================================
--- 1.3/generic_fns/structure/scientific.py (original)
+++ 1.3/generic_fns/structure/scientific.py Sun Apr 20 18:11:54 2008
@@ -111,8 +111,11 @@
     def __residue_loop(self, mol, mol_type, residues):
         """Generator function for looping over all residues in the 
Scientific PDB data objects.
 
-        @param mol:         The individual residue Scientific Python PDB 
data object.
+        @param mol:         The individual molecule Scientific Python PDB 
data object.
         @type mol:          Scientific Python PDB object
+        @param mol_type:    The type of the molecule.  This can be one of 
'protein', 'nucleic acid',
+                            or 'other'.
+        @type mol_type:     str
         @param residues:    A list of residue names.  If non-empty, only 
residues found in this list
                             will be returned.
         @type residues:     list of str