r5558 - /1.3/generic_fns/state.py -- April 10, 2008 - 16:54

Author: bugman
Date: Thu Apr 10 16:54:04 2008
New Revision: 5558

URL: http://svn.gna.org/viewcvs/relax?rev=5558&view=rev
Log:
Epydoc fixes.


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=5558&r1=5557&r2=5558&view=diff
==============================================================================
--- 1.3/generic_fns/state.py (original)
+++ 1.3/generic_fns/state.py Thu Apr 10 16:54:04 2008
@@ -32,9 +32,9 @@
 def load_state(state=None, dir_name=None):
     """Function for loading a saved program state.
 
-    @param state:       The saved state file.
+    @keyword state:     The saved state file.
     @type state:        str
-    @param dir_name:    The path of the state file.
+    @keyword dir_name:  The path of the state file.
     @type dir_name:     str
     """
 
@@ -80,14 +80,14 @@
 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.
+    @keyword state:         The saved state file.
     @type state:            str
-    @param dir_name:        The path of the state file.
+    @keyword 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
+    @keyword 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
+    @keyword 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
     """