summaryrefslogtreecommitdiff
path: root/docutils/__init__.py
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-08-29 02:49:34 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-08-29 02:49:34 +0000
commit2b57d30609bb5efa7031d6aa3fdaaa9143c8041e (patch)
tree80f2425bf23076369ebf4b1389503b4ad51dc68c /docutils/__init__.py
parent06cb0f166194caa2991d5e1c4c9b7d8d88e3d748 (diff)
downloaddocutils-2b57d30609bb5efa7031d6aa3fdaaa9143c8041e.tar.gz
Added ``option_default_overrides`` to ``docutils.OptionSpec``.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@609 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/__init__.py')
-rw-r--r--docutils/__init__.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/docutils/__init__.py b/docutils/__init__.py
index 097aa3944..c50574045 100644
--- a/docutils/__init__.py
+++ b/docutils/__init__.py
@@ -68,20 +68,26 @@ class DataError(ApplicationError): pass
class OptionSpec:
- """Runtime option specification base class."""
+ """
+ Runtime option specification base class.
+
+ OptionSpec subclass objects used by `docutils.frontend.OptionParser`.
+ """
cmdline_options = ()
"""Command-line option specification. Override in subclasses.
- Used by `docutils.frontend.OptionParser`.
One or more sets of option group title, description, and a list/tuple of
tuples: ``('help text', [list of option strings], {keyword arguments})``.
Group title and/or description may be `None`; no group title implies no
group, just a list of single options."""
+ option_default_overrides = None
+ """A dictionary of auxiliary defaults, to override defaults for options
+ defined in other components. Override in subclasses."""
+
relative_path_options = ()
"""Options containing filesystem paths. Override in subclasses.
- Used by `docutils.frontend.OptionParser`.
Options listed here are to be interpreted relative to the current working
directory."""