Small fixes, mostly documentation. Test more "list" settings.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8998 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

1 files changed, 11 insertions, 0 deletions

diff --git a/docutils/__init__.py b/docutils/__init__.py
index 2280a2855..358fc7d8b 100644
--- a/docutils/__init__.py
+++ b/docutils/__init__.py
@@ -139,6 +139,17 @@ class SettingsSpec:
     SettingsSpec subclass objects used by `docutils.frontend.OptionParser`.
     """
 
+    # TODO: replace settings_specs with a new data structure
+    # Backwards compatiblity:
+    #   Drop-in components:
+    #   Sphinx supplies settings_spec in the current format in some places
+    #   Myst parser provides a settings_spec tuple
+    #
+    #   Sphinx reads a settings_spec in order to set a default value
+    #   in writers/html.py:59
+    #   https://github.com/sphinx-doc/sphinx/blob/4.x/sphinx/writers/html.py
+    #   This should be changed (before retiring the old format)
+    #   to use `settings_default_overrides` instead.
     settings_spec = ()
     """Runtime settings specification.  Override in subclasses.