From 8577703511e25777361c4373e7e6ffbb1fe46144 Mon Sep 17 00:00:00 2001
From: Michael Spang <mspang@uwaterloo.ca>
Date: Sun, 28 Jan 2007 22:54:56 -0500
Subject: [PATCH] Docstring update: documented parameters and exceptions of
 conf.read().

---
 pylib/csc/common/conf.py | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/pylib/csc/common/conf.py b/pylib/csc/common/conf.py
index c49bb62..e22d03e 100644
--- a/pylib/csc/common/conf.py
+++ b/pylib/csc/common/conf.py
@@ -30,7 +30,7 @@ Example Configuration File:
     white space = sure, why not
 
     # these two lines are treated as one
-    long line = first line \
+    long line = first line \\
                 second line
 
 Resultant Dictionary:
@@ -44,7 +44,7 @@ Resultant Dictionary:
       'arbitrary_string': '2',
       'csclub': None,
       'white space': 'sure, why not'
-      'long line': 'first line \n               second line' 
+      'long line': 'first line \\n               second line' 
       
       ... (data from other.cf) ...
     }
@@ -58,7 +58,16 @@ class ConfigurationException(Exception):
     
 
 def read(filename, included=None):
-    """Function to read a configuration file into a dictionary."""
+    """
+    Function to read a configuration file into a dictionary.
+    
+    Parmaeters:
+        filename - the file to read
+        included - files previously read (internal)
+    
+    Exceptions:
+        ConfigurationException - when the configuration file cannot be read
+    """
 
     if not included:
         included = []