r3518 - /1.3/generic_fns/spin.py -- November 11, 2007 - 22:59

Author: bugman
Date: Sun Nov 11 22:59:16 2007
New Revision: 3518

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


Modified:
    1.3/generic_fns/spin.py

Modified: 1.3/generic_fns/spin.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/spin.py?rev=3518&r1=3517&r2=3518&view=diff
==============================================================================
--- 1.3/generic_fns/spin.py (original)
+++ 1.3/generic_fns/spin.py Sun Nov 11 22:59:16 2007
@@ -107,7 +107,15 @@
 
 
 def create(spin_num=None, spin_name=None, res_id=None):
-    """Function for adding a spin into the relax data store."""
+    """Function for adding a spin into the relax data store.
+    
+    @param spin_num:    The identification number of the new spin.
+    @type spin_num:     int
+    @param spin_name:   The name of the new spin.
+    @type spin_name:    str
+    @param res_id:      The molecule and residue identification string.
+    @type res_id:       str
+    """
 
     # Split up the selection string.
     mol_token, res_token, spin_token = tokenise(res_id)