SF.net SVN: docutils:[9941] trunk/docutils

Revision: 9941
          http://sourceforge.net/p/docutils/code/9941
Author:   milde
Date:     2024-09-28 21:23:32 +0000 (Sat, 28 Sep 2024)
Log Message:
-----------
Minor documentation fixes.

Modified Paths:
--------------
    trunk/docutils/HISTORY.rst
    trunk/docutils/RELEASE-NOTES.rst
    trunk/docutils/docs/ref/rst/restructuredtext.rst

Modified: trunk/docutils/HISTORY.rst
===================================================================
--- trunk/docutils/HISTORY.rst	2024-09-26 14:09:49 UTC (rev 9940)
+++ trunk/docutils/HISTORY.rst	2024-09-28 21:23:32 UTC (rev 9941)
@@ -22,8 +22,8 @@
   - We have started to add type hints to Docutils.
     This will be a complex programme of work, and as such
     for the time being these type hints are 'provisional',
-    and should not be relied upon by consumers of Docutils.
-    (feature-request #87)
+    and should not be relied upon by consumers of Docutils
+    (feature-request #87).
   - Add tox.ini to pyproject.toml to be in sdist (bug #486).
   - Fix license issue (bug #487).
 
@@ -61,7 +61,7 @@
     Provisional.
   - New "attribute validating functions"
     convert string representations to correct data type,
-    normalize values,
+    normalize values, and
     raise ValueError for invalid attribute names or values.
   - New function `parse_measure()`.
   - Removed `Element.set_class()`.
@@ -70,14 +70,15 @@
 
   - New parser for Docutils XML sources. Provisional.
 
+* docutils/parsers/recommonmark_wrapper.py
+
+  - New method `Parser.finish_parse()` to clean up (before validating).
+
 * docutils/parsers/rst/languages/
 
   - Removed mistranslations of the "admonition" directive name.
 
-* docutils/parsers/recommonmark_wrapper.py
 
-  - New method `Parser.finish_parse()` to clean up (before validating).
-
 * docutils/parsers/rst/directives/misc.py
 
   - Pass the included file's path to the parser when the

Modified: trunk/docutils/RELEASE-NOTES.rst
===================================================================
--- trunk/docutils/RELEASE-NOTES.rst	2024-09-26 14:09:49 UTC (rev 9940)
+++ trunk/docutils/RELEASE-NOTES.rst	2024-09-28 21:23:32 UTC (rev 9941)
@@ -107,11 +107,11 @@
 
     __ docs/user/latex.html#length-units
 
-Misc
-----
+Removals
+--------
 
 * Remove `io.BinaryFileOutput` and `core.publish_cmdline_to_binary()`
-  in Docutils 0.24.
+  in Docutils 0.24.
 
 * Remove `parsers.rst.directives.CSVTable.HeaderDialect`
   in Docutils 1.0.
@@ -131,7 +131,7 @@
 * Remove the "rawsource" argument from `nodes.Text.__init__()`
   in Docutils 2.0.
 
-* Remove the deprecated attributes `nodes.Element.known_attributes`,
+* Remove attributes `nodes.Element.known_attributes`,
   `nodes.Element.basic_attributes`, and `nodes.Element.local_attributes`,
   in Docutils 2.0.
 
@@ -146,6 +146,9 @@
   functions in Docutils 2.0.  Since Docutils 0.22, you may use "reader",
   "parser", and "writer" arguments for component names as well as instances.
 
+Misc
+----
+
 * Revise the `String I/O`__ interface used by the `publish_string()`
   and `publish_from_doctree()` publisher convenience functions.
   (In Python 3, name and behaviour no longer match.)

Modified: trunk/docutils/docs/ref/rst/restructuredtext.rst
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.rst	2024-09-26 14:09:49 UTC (rev 9940)
+++ trunk/docutils/docs/ref/rst/restructuredtext.rst	2024-09-28 21:23:32 UTC (rev 9941)
@@ -3083,6 +3083,11 @@
 manuals (`directive option`_ values of type "length__" or "percentage__").
 In the `document tree`_, they are stored in attributes of type `measure`_.
 
+It is up to the processing system to provide a fallback/workaround
+or raise an error if the output format does not support a unit
+(or values without unit).
+For the behaviour of the Docutils writers, see the `writer documentation`_.
+
 .. _directive option: `directive options`_
 __ directives.html#length
 __ directives.html#percentage
@@ -3103,20 +3108,14 @@
 ----  ---------------------------------------------------------
 cm    centimeters              1 cm = 10 mm
 mm    millimeters              1 mm = 1/1000 m
-in    inches                   1 in = 2.54 cm = 96 px
+in    inches                   1 in = 25.4 mm = 96 px
 pc    picas                    1 pc = 1/6 in = 12 pt
 pt    points                   1 pt = 1/72 in
 px    pixels                   1 px = 3/4 pt = 1/96 in [#]_
 ====  =======================  ================================
 
-The following are all valid length values:
-"1.5em", "20 mm", ".5 in", "42".
+The following are all valid length values: "1.5em", "20 mm", ".5 in", "42".
 
-It is up to the processing system to provide a fallback/workaround or
-raise an error if the output format does not support a unit or
-values without unit.  For the behaviour of the Docutils writers,
-see the `writer documentation`_.
-
 .. [#] a subset of `length units in CSS3`_
 .. [#] In LaTeX, the default definition is 1 px = 1 pt = 1/72 in
    (cf. section `Length units <../../user/latex.html#length-units>`__

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



_______________________________________________
Docutils-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/docutils-checkins