diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2002-11-21 02:27:00 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2002-11-21 02:27:00 +0000 |
| commit | f5e7d4b1ce7cb79a5f2b987c9833d952a843bc41 (patch) | |
| tree | 3759fe2428e106584a22e42f431eb0d157dd0307 /docutils/utils.py | |
| parent | 81d959d8ec43bfb13eb65c8519803aff94f0fa8c (diff) | |
| download | docutils-f5e7d4b1ce7cb79a5f2b987c9833d952a843bc41.tar.gz | |
added docstring
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@971 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/utils.py')
| -rw-r--r-- | docutils/utils.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docutils/utils.py b/docutils/utils.py index a216e114a..809511cba 100644 --- a/docutils/utils.py +++ b/docutils/utils.py @@ -373,6 +373,15 @@ def normalize_name(name): 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, |
