r6380 - /1.3/prompt/results.py -- June 22, 2008 - 13:05

Author: bugman
Date: Sun Jun 22 13:05:01 2008
New Revision: 6380

URL: http://svn.gna.org/viewcvs/relax?rev=6380&view=rev
Log:
Changed the default values of the args of the results.write() user function.

The dir arg now defaults to the special value of 'pipe_name' and the format 
arg defaults to 'xml'.


Modified:
    1.3/prompt/results.py

Modified: 1.3/prompt/results.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/prompt/results.py?rev=6380&r1=6379&r2=6380&view=diff
==============================================================================
--- 1.3/prompt/results.py (original)
+++ 1.3/prompt/results.py Sun Jun 22 13:05:01 2008
@@ -102,7 +102,7 @@
         results.read(file=file, directory=dir)
 
 
-    def write(self, file='results', dir='dir', force=False, 
format='columnar', compress_type=1):
+    def write(self, file='results', dir='pipe_name', force=False, 
format='xml', compress_type=1):
         """Function for writing results to a file.
 
         Keyword Arguments
@@ -122,7 +122,9 @@
         Description
         ~~~~~~~~~~~
 
-        To place the results file in the current working directory, set dir 
to None.
+        To place the results file in the current working directory, set dir 
to None.  If dir is set
+        to the special name 'pipe_name', then the results file will be 
placed into a directory with
+        the same name as the current data pipe.
 
         The default behaviour of this function is to compress the file using 
bzip2 compression.  If
         the extension '.bz2' is not included in the file name, it will be 
added.  The compression