r4543 - /1.3/generic_fns/state.py -- January 09, 2008 - 14:19

Author: bugman
Date: Wed Jan  9 14:19:47 2008
New Revision: 4543

URL: http://svn.gna.org/viewcvs/relax?rev=4543&view=rev
Log:
Updated the generic_fns.state.save_state() function.

The docstring has been converted to epydoc format and the 'force' arg 
converted to a bool.


Modified:
    1.3/generic_fns/state.py

Modified: 1.3/generic_fns/state.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/state.py?rev=4543&r1=4542&r2=4543&view=diff
==============================================================================
--- 1.3/generic_fns/state.py (original)
+++ 1.3/generic_fns/state.py Wed Jan  9 14:19:47 2008
@@ -73,8 +73,20 @@
     del state
 
 
-def save_state(state=None, dir_name=None, force=0, compress_type=1):
-    """Function for saving the program state."""
+def save_state(state=None, dir_name=None, force=False, compress_type=1):
+    """Function for saving the program state.
+
+    @param state:           The saved state file.
+    @type state:            str
+    @param dir_name:        The path of the state file.
+    @type dir_name:         str
+    @param force:           Boolean argument which if True causes the file 
to be overwritten if it
+                            already exists.
+    @type force:            bool
+    @param compress_type:   The compression type.  The integer values 
correspond to the compression
+                            type: 0, no compression; 1, Bzip2 compression; 
2, Gzip compression.
+    @type compress_type:    int
+    """
 
     # Open the file for writing.
     file = open_write_file(file_name=state, dir=dir_name, force=force, 
compress_type=compress_type)