[Docutils-checkins] SF.net SVN: docutils:[9990] trunk/docutils

[<mi...@us...>]

Revision: 9990
          http://sourceforge.net/p/docutils/code/9990
Author:   milde
Date:     2024-11-25 13:48:58 +0000 (Mon, 25 Nov 2024)
Log Message:
-----------
Small documentation fixes.

Fix typo and add explanation in HISTORY.

Formatting in RELEASE NOTES.

Mark "parser" option of the "include" directive as provisional.

`frontend.OptionParser`: Add replacement hint to deprectaion warning.

Modified Paths:
--------------
    trunk/docutils/HISTORY.rst
    trunk/docutils/RELEASE-NOTES.rst
    trunk/docutils/docs/ref/rst/directives.rst
    trunk/docutils/docutils/frontend.py

Modified: trunk/docutils/HISTORY.rst
===================================================================
--- trunk/docutils/HISTORY.rst	2024-11-24 17:15:41 UTC (rev 9989)
+++ trunk/docutils/HISTORY.rst	2024-11-25 13:48:58 UTC (rev 9990)
@@ -99,7 +99,7 @@
 
 * docutils/parsers/rst/roles.py
 
-  - Renamed `normalized_role_options()` to `normalized_role_options()`
+  - Renamed `normalized_role_options()` to `normalize_options()`
     (it is now also used for directive options).
 
 * docutils/parsers/rst/states.py
@@ -770,7 +770,8 @@
 * docutils/frontend.py
   - Mark as provisional (will switch from using `optparse` to `argparse`).
   - Remove hack for the now obsolete "mod_python" Apache module.
-  - New function `get_default_settings()`.
+  - New function `get_default_settings()` as a replacement for the
+    deprecated `OptionParser`\ s `get_default_values()` method.
 
 * docutils/nodes.py
 

Modified: trunk/docutils/RELEASE-NOTES.rst
===================================================================
--- trunk/docutils/RELEASE-NOTES.rst	2024-11-24 17:15:41 UTC (rev 9989)
+++ trunk/docutils/RELEASE-NOTES.rst	2024-11-25 13:48:58 UTC (rev 9990)
@@ -60,13 +60,12 @@
 * The "rst" parser will warn if a "figure" directive is missing both
   caption and legend in Docutils 1.0.
 
-* Values of the `"colwidth" attribute`_ will be stored in Python
-  element instances as `str` (with unit "*" for proportional values)
-  in Docutils 1.0.  (The method `nodes.colspec.propwidth()` provides
-  a stable means to extract a proportionional value as number.)
+* To match the definition in the "Exchange Table Model", the
+  `"colwidth" attribute`_ will be stored as a `str` (instead of
+  numerical) value in Python element instances in Docutils 1.0.
+  Proportional values will be stored with unit "*" in Docutils 2.0.
+  The default unit will change to "pt" in Docutils 3.0.
 
-  The default unit will change to "pt" in Docutils 2.0.
-
 * The `\<doctest_block>`_ element will be deprecated in Docutils 1.0.
   The rST parser will handle a `doctest block`_ similar to a "code" directive
   with language "pycon" (Python console) and generate a <literal_block>.
@@ -490,8 +489,6 @@
 Release 0.19 (2022-07-05)
 =========================
 
-(Release 0.19b1 (2022-06-21))
-
 * Drop support for Python 2.7, 3.5, and 3.6.
 
 * Output changes:

Modified: trunk/docutils/docs/ref/rst/directives.rst
===================================================================
--- trunk/docutils/docs/ref/rst/directives.rst	2024-11-24 17:15:41 UTC (rev 9989)
+++ trunk/docutils/docs/ref/rst/directives.rst	2024-11-25 13:48:58 UTC (rev 9990)
@@ -1607,7 +1607,7 @@
        There is is no check whether the inserted elements are valid at the
        point of insertion. It is recommended to validate_ the document.
 
-    (New in Docutils 0.17)
+    (New in Docutils 0.17. Provisional.)
 
 ``start-after`` : text_
     Only the content after the first occurrence of the specified *text*

Modified: trunk/docutils/docutils/frontend.py
===================================================================
--- trunk/docutils/docutils/frontend.py	2024-11-24 17:15:41 UTC (rev 9989)
+++ trunk/docutils/docutils/frontend.py	2024-11-25 13:48:58 UTC (rev 9990)
@@ -901,10 +901,11 @@
 
         self.relative_path_settings = ('warning_stream',)  # will be modified
 
-        warnings.warn('The frontend.OptionParser class will be replaced '
-                      'by a subclass of argparse.ArgumentParser '
-                      'in Docutils 0.21 or later.',
-                      DeprecationWarning, stacklevel=2)
+        warnings.warn(
+            'The frontend.OptionParser class will be replaced by a subclass '
+            'of argparse.ArgumentParser in Docutils 0.21 or later.\n  '
+            'To get default settings, use frontend.get_default_settings().',
+            DeprecationWarning, stacklevel=2)
         super().__init__(option_class=Option, add_help_option=False,
                          formatter=optparse.TitledHelpFormatter(width=78),
                          *args, **kwargs)

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.