r4542 - /1.3/generic_fns/state.py -- January 09, 2008 - 14:16

Author: bugman
Date: Wed Jan  9 14:16:22 2008
New Revision: 4542

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

The compression flag has been dropped as it is automatically determined and 
the docstring has been
converted to epydoc format.


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=4542&r1=4541&r2=4542&view=diff
==============================================================================
--- 1.3/generic_fns/state.py (original)
+++ 1.3/generic_fns/state.py Wed Jan  9 14:16:22 2008
@@ -1,6 +1,6 @@
 
###############################################################################
 #                                                                            
 #
-# Copyright (C) 2003-2004, 2007 Edward d'Auvergne                            
 #
+# Copyright (C) 2003-2004, 2007-2008 Edward d'Auvergne                       
 #
 #                                                                            
 #
 # This file is part of the program relax.                                    
 #
 #                                                                            
 #
@@ -28,8 +28,14 @@
 from relax_io import open_read_file, open_write_file
 
 
-def load_state(state=None, dir_name=None, compress_type=1):
-    """Function for loading a saved program state."""
+def load_state(state=None, dir_name=None):
+    """Function for loading a saved program state.
+
+    @param state:       The saved state file.
+    @type state:        str
+    @param dir_name:    The path of the state file.
+    @type dir_name:     str
+    """
 
     # Open the file for reading.
     file = open_read_file(file_name=state, dir=dir_name)