[Docutils-checkins] docutils/docutils utils.py,1.20,1.21

[David G. <go...@us...>]

Update of /cvsroot/docutils/docutils/docutils
In directory sc8-pr-cvs1:/tmp/cvs-serv29171/docutils/docutils

Modified Files:
	utils.py 
Log Message:
added  docstring

Index: utils.py
===================================================================
RCS file: /cvsroot/docutils/docutils/docutils/utils.py,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -d -r1.20 -r1.21
--- utils.py	8 Nov 2002 01:34:27 -0000	1.20
+++ utils.py	21 Nov 2002 02:27:00 -0000	1.21
@@ -373,6 +373,15 @@
     return ' '.join(name.lower().split())
 
 def new_document(source, settings=None):
+    """
+    Return a new empty document object.
+
+    :Parameters:
+        `source` : string
+            The path to or description of the source text of the document.
+        `settings` : optparse.Values object
+            Runtime settings.  If none provided, a default set will be used.
+    """
     if settings is None:
         settings = frontend.OptionParser().get_default_values()
     reporter = Reporter(source, settings.report_level, settings.halt_level,