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

Revision: 10105
          http://sourceforge.net/p/docutils/code/10105
Author:   milde
Date:     2025-04-25 14:29:41 +0000 (Fri, 25 Apr 2025)
Log Message:
-----------
Documentation update.

Unify naming of Docutils library objects in RELEASE NOTES:
skip the initial `docutils`.

Simplify docstring for `nodes.document.set_name_id_map()`.

Modified Paths:
--------------
    trunk/docutils/RELEASE-NOTES.rst
    trunk/docutils/docutils/nodes.py

Modified: trunk/docutils/RELEASE-NOTES.rst
===================================================================
--- trunk/docutils/RELEASE-NOTES.rst	2025-04-25 13:13:48 UTC (rev 10104)
+++ trunk/docutils/RELEASE-NOTES.rst	2025-04-25 14:29:41 UTC (rev 10105)
@@ -295,21 +295,21 @@
      Provisional.
 
 Removed objects
-  `docutils.core.Publisher.setup_option_parser()`
+  `core.Publisher.setup_option_parser()`
      internal, obsolete,
-  `docutils.frontend.OptionParser.set_defaults_from_dict()`
+  `frontend.OptionParser.set_defaults_from_dict()`
      obsolete,
-  `docutils.nodes.Element.set_class()`
+  `nodes.Element.set_class()`
      obsolete, append to Element['classes'] directly,
-  `docutils.parsers.rst.directives.tables.CSVTable.decode_from_csv()`
+  `parsers.rst.directives.tables.CSVTable.decode_from_csv()`
      not required with Python 3,
-  `docutils.parsers.rst.directives.tables.CSVTable.encode_from_csv()`
+  `parsers.rst.directives.tables.CSVTable.encode_from_csv()`
      not required with Python 3,
-  `docutils.transforms.writer_aux.Compound`
+  `transforms.writer_aux.Compound`
      not used since Dec 2010,
-  `docutils.utils.error_reporting`
+  `utils.error_reporting`
      obsolete in Python 3,
-  `docutils.utils.Reporter.set_conditions()`
+  `utils.Reporter.set_conditions()`
      obsolete, set attributes via configuration settings or directly.
 
 Removed localisations:
@@ -321,7 +321,7 @@
 
 Removed files
   ``tools/rst2odt_prepstyles.py``
-     Obsoleted by `docutils.writers.odf_odt.prepstyles`.
+     Obsoleted by `writers.odf_odt.prepstyles`.
   ``docutils/utils/roman.py``
      Obsoleted by ``docutils/utils/_roman_numerals.py``
 
@@ -419,9 +419,9 @@
 
 * Removed objects:
 
-  `docutils.nodes.reprunicode`, `docutils.nodes.ensure_str()`
+  `nodes.reprunicode`, `nodes.ensure_str()`
     Python 2 compatibility hacks
-  `docutils.utils.Reporter.set_conditions()`
+  `utils.Reporter.set_conditions()`
     obsolete
   `writers.latex2e.Table.get_caption`
     obsolete

Modified: trunk/docutils/docutils/nodes.py
===================================================================
--- trunk/docutils/docutils/nodes.py	2025-04-25 13:13:48 UTC (rev 10104)
+++ trunk/docutils/docutils/nodes.py	2025-04-25 14:29:41 UTC (rev 10105)
@@ -1857,31 +1857,29 @@
                         ) -> None:
         """
         `self.nameids` maps names to IDs, while `self.nametypes` maps names to
-        booleans representing hyperlink type (True==explicit,
+        booleans representing hyperlink target type (True==explicit,
         False==implicit).  This method updates the mappings.
 
         The following state transition table shows how `self.nameids` items
         ("id") and `self.nametypes` items ("type") change with new input
-        (a call to this method), and what actions are performed
-        ("implicit"-type system messages are INFO/1, and
-        "explicit"-type system messages are ERROR/3):
+        (a call to this method), and what actions are performed:
 
-        ====  =====  ========  ========  =======  ====  =====  =====
-         Old State    Input          Action        New State   Notes
-        -----------  --------  -----------------  -----------  -----
-        id    type   new type  sys.msg.  dupname  id    type
-        ====  =====  ========  ========  =======  ====  =====  =====
-        -     -      explicit  -         -        new   True
-        -     -      implicit  -         -        new   False
-        -     False  explicit  -         -        new   True
-        old   False  explicit  implicit  old      new   True
-        -     True   explicit  explicit  new      -     True
-        old   True   explicit  explicit  new,old  -     True   [#]_
-        -     False  implicit  implicit  new      -     False
-        old   False  implicit  implicit  new,old  -     False
-        -     True   implicit  implicit  new      -     True
-        old   True   implicit  implicit  new      old   True
-        ====  =====  ========  ========  =======  ====  =====  =====
+        ====  ========  ========  ========  =======  ====  ========  =====
+          Old State      Input          Action        New State      Notes
+        --------------  --------  -----------------  --------------  -----
+        id    type      new type  sys.msg.  dupname  id    type
+        ====  ========  ========  ========  =======  ====  ========  =====
+        -     -         explicit  -         -        new   explicit
+        -     -         implicit  -         -        new   implicit
+        -     implicit  explicit  -         -        new   explicit
+        old   implicit  explicit  INFO      old      new   explicit
+        -     explicit  explicit  ERROR     new      -     explicit
+        old   explicit  explicit  ERROR     new,old  -     explicit  [#]_
+        -     implicit  implicit  INFO      new      -     implicit
+        old   implicit  implicit  INFO      new,old  -     implicit
+        -     explicit  implicit  INFO      new      -     explicit
+        old   explicit  implicit  INFO      new      old   explicit
+        ====  ========  ========  ========  =======  ====  ========  =====
 
         .. [#] Do not clear the name-to-id map or invalidate the old target if
            both old and new targets are external and refer to identical URIs.

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