r4175 - /1.3/generic_fns/value.py -- December 09, 2007 - 22:17

Author: bugman
Date: Sun Dec  9 22:17:55 2007
New Revision: 4175

URL: http://svn.gna.org/viewcvs/relax?rev=4175&view=rev
Log:
Updated the docstring of the generic_fns.value.set() function.


Modified:
    1.3/generic_fns/value.py

Modified: 1.3/generic_fns/value.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/value.py?rev=4175&r1=4174&r2=4175&view=diff
==============================================================================
--- 1.3/generic_fns/value.py (original)
+++ 1.3/generic_fns/value.py Sun Dec  9 22:17:55 2007
@@ -179,8 +179,18 @@
     return tensor_params, tensor_values, spin_params, spin_values
 
 
-def set(val=None, param=None, spin_id=None, force=0):
-    """Function for setting residue specific data values."""
+def set(val=None, param=None, spin_id=None, force=False):
+    """Function for setting residue specific data values.
+
+    @param val:     The parameter values.
+    @type val:      None, number, or list of numbers
+    @param param:   The parameter names.
+    @type val:      None, str, or list of str
+    @param spin_id: The spin identification string.
+    @type spin_id:  str
+    @param force:   A flag forcing the overwriting of current values.
+    @type force:    bool
+    """
 
     # Test if the current data pipe exists.
     if not relax_data_store.current_pipe: