r4531 - /1.3/relax_io.py -- January 09, 2008 - 11:48

Author: bugman
Date: Wed Jan  9 11:48:33 2008
New Revision: 4531

URL: http://svn.gna.org/viewcvs/relax?rev=4531&view=rev
Log:
Updated the relax_io.get_file_path() function.

The docstring has been updated to epydoc format.


Modified:
    1.3/relax_io.py

Modified: 1.3/relax_io.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/relax_io.py?rev=4531&r1=4530&r2=4531&view=diff
==============================================================================
--- 1.3/relax_io.py (original)
+++ 1.3/relax_io.py Wed Jan  9 11:48:33 2008
@@ -99,8 +99,17 @@
 
 
 def get_file_path(file_name=None, dir=None):
-    """Generate and expand the full file path."""
-
+    """Generate and expand the full file path.
+
+    @param file_name:   The name of the file to extract the data from.
+    @type file_name:    str
+    @param dir:         The path where the file is located.  If None, then 
the current directory is
+                        assumed.
+    @type dir:          str
+    @return:            The full file path.
+    @type return:       str
+    """
+ 
     # File name.
     file_path = file_name