r7574 - /1.3/generic_fns/value.py -- October 07, 2008 - 23:25

Author: bugman
Date: Tue Oct  7 23:25:23 2008
New Revision: 7574

URL: http://svn.gna.org/viewcvs/relax?rev=7574&view=rev
Log:
Fix for the write_data() function.

The file arg was missing from the write_header() call, and the docstring has 
been converted to
epydoc format.


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=7574&r1=7573&r2=7574&view=diff
==============================================================================
--- 1.3/generic_fns/value.py (original)
+++ 1.3/generic_fns/value.py Tue Oct  7 23:25:23 2008
@@ -591,7 +591,17 @@
 
 
 def write_data(param=None, file=None, return_value=None):
-    """Function for writing data."""
+    """The function which actually writes the data.
+
+    @keyword file:          The file to write the data to.
+    @type file:             str
+    @keyword dir:           The name of the directory to place the file into 
(defaults to the
+                            current directory).
+    @type dir:              str
+    @keyword return_value:  An optional function which if supplied will 
override the default value
+                            returning function.
+    @type return_value:     None or func
+    """
 
     # Get the value and error returning function if required.
     if not return_value:
@@ -601,7 +611,7 @@
     format = "%-30s%-30s"
 
     # Write a header line.
-    write_header(extra_format=format, extra_values=('Value', 'Error'), 
mol_name_flag=True, res_num_flag=True, res_name_flag=True, 
spin_num_flag=True, spin_name_flag=True)
+    write_header(file, extra_format=format, extra_values=('Value', 'Error'), 
mol_name_flag=True, res_num_flag=True, res_name_flag=True, 
spin_num_flag=True, spin_name_flag=True)
 
     # Loop over the sequence.
     for spin, mol_name, res_num, res_name in spin_loop(full_info=True):