[Docutils-checkins] r6391 - trunk/docutils/docutils/utils.py

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

Author: goodger
Date: 2010-08-16 22:31:00 +0200 (Mon, 16 Aug 2010)
New Revision: 6391

Modified:
   trunk/docutils/docutils/utils.py
Log:
added settings & components instructions to new_document

Modified: trunk/docutils/docutils/utils.py
===================================================================
--- trunk/docutils/docutils/utils.py	2010-08-16 19:48:38 UTC (rev 6390)
+++ trunk/docutils/docutils/utils.py	2010-08-16 20:31:00 UTC (rev 6391)
@@ -433,7 +433,15 @@
         `source_path` : 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.
+            Runtime settings.  If none are provided, a default core set will
+            be used.  If you will use the document object with any Docutils
+            components, you must provide their default settings as well.  For
+            example, if parsing, at least provide the parser settings,
+            obtainable as follows::
+
+                settings = docutils.frontend.OptionParser(
+                    components=(docutils.parsers.rst.Parser,)
+                    ).get_default_values()
     """
     from docutils import frontend
     if settings is None: