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

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

Revision: 9362
          http://sourceforge.net/p/docutils/code/9362
Author:   milde
Date:     2023-04-21 17:41:17 +0000 (Fri, 21 Apr 2023)
Log Message:
-----------
Last documentation edits for 0.20 release.

Review and small corrections to HISTORY and RELEASE-NOTES.

Add comment with rationale for future cvs-table changes.

Modified Paths:
--------------
    trunk/docutils/HISTORY.txt
    trunk/docutils/RELEASE-NOTES.txt
    trunk/docutils/docutils/parsers/rst/directives/tables.py

Modified: trunk/docutils/HISTORY.txt
===================================================================
--- trunk/docutils/HISTORY.txt	2023-04-20 23:04:43 UTC (rev 9361)
+++ trunk/docutils/HISTORY.txt	2023-04-21 17:41:17 UTC (rev 9362)
@@ -26,6 +26,7 @@
   - New argument "auto_encode" for `publish_string()`,
     `publish_from_docstring()` and `publish_programmatically()`.
   - New functions `rst2…()` for use as "console_scripts" `entry points`_.
+    (cf. `Future changes` in the RELEASE-NOTES_).
 
 * docutils/frontend.py
 
@@ -82,7 +83,7 @@
 
 * docutils/utils/math/latex2mathml.py
 
-  - Support "mod" notation for modulo operation/modulus arithmetic.
+  - Support "mod" notation for modulo operation / modulus arithmetic.
 
 * docutils/utils/math/tex2mathml_extern.py
 
@@ -126,8 +127,8 @@
 
 * docutils/writers/xetex/__init__.py
 
-  - Ignore settings in the [latex2e writer] configuration file section
-    (users can place common settings in section [latex writers]).
+  - Ignore settings in the [latex2e writer] configuration file section.
+    Place common settings in section [latex writers].
 
 * setup.py
 

Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt	2023-04-20 23:04:43 UTC (rev 9361)
+++ trunk/docutils/RELEASE-NOTES.txt	2023-04-21 17:41:17 UTC (rev 9362)
@@ -206,11 +206,15 @@
     Use dpub-ARIA role "doc-footnote" (instead of ARIA role "note")
     for footnotes.
 
+  LaTeX:
+    Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
+    (UTF-8 is the default encoding for LaTeX2e since 2018).
+
 * Configuration changes:
 
   - Settings in the [latex2e writer] configuration file section
     are now ignored by the "xetex" writer.
-    Users can place common settings in section `[latex writers]`_.
+    Place common settings in section `[latex writers]`_.
 
     .. _[latex writers]: docs/user/config.html#latex-writers
 

Modified: trunk/docutils/docutils/parsers/rst/directives/tables.py
===================================================================
--- trunk/docutils/docutils/parsers/rst/directives/tables.py	2023-04-20 23:04:43 UTC (rev 9361)
+++ trunk/docutils/docutils/parsers/rst/directives/tables.py	2023-04-21 17:41:17 UTC (rev 9362)
@@ -234,12 +234,25 @@
             super().__init__()
 
     class HeaderDialect(csv.Dialect):
+        """
+        CSV dialect used for the "header" option data.
 
-        """CSV dialect used for the "header" option data.
-
         Deprecated. Will be removed in Docutils 0.22.
         """
-
+        # The separate HeaderDialect was introduced in revision 2294
+        # (2004-06-17) in the sandbox before the "csv-table" directive moved
+        # to the trunk in r2309. Discussion in docutils-devel around this time
+        # did not mention a rationale (part of the discussion was in private
+        # mail).
+        # This is in conflict with the documentation, which always said:
+        # ""
+        # and did not change in this aspect.
+        #
+        # Maybe it was intended to have similar escape rules for rST and CSV,
+        # however with the current implementation this means we need
+        # `\\` for rST markup and ``\\\\`` for a literal backslash
+        # in the "option" header but ``\`` and ``\\`` in the header-lines and
+        # table cells of the main CSV data.
         delimiter = ','
         quotechar = '"'
         escapechar = '\\'

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