r3519 - /1.3/generic_fns/residue.py -- November 11, 2007 - 23:00

Author: bugman
Date: Sun Nov 11 23:00:43 2007
New Revision: 3519

URL: http://svn.gna.org/viewcvs/relax?rev=3519&view=rev
Log:
Completed the generic_fns.residue.create() docstring.


Modified:
    1.3/generic_fns/residue.py

Modified: 1.3/generic_fns/residue.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/residue.py?rev=3519&r1=3518&r2=3519&view=diff
==============================================================================
--- 1.3/generic_fns/residue.py (original)
+++ 1.3/generic_fns/residue.py Sun Nov 11 23:00:43 2007
@@ -103,7 +103,15 @@
 
 
 def create(res_num=None, res_name=None):
-    """Function for adding a residue into the relax data store."""
+    """Function for adding a residue into the relax data store.
+
+    @param res_num:     The identification number of the new residue.
+    @type res_num:      int
+    @param res_name:    The name of the new residue.
+    @type res_name:     str
+    @param mol_id:      The molecule identification string.
+    @type mol_id:       str
+    """
 
     # Test if the current data pipe exists.
     if not relax_data_store.current_pipe: