SF.net SVN: docutils:[10273 ] trunk/docutils/docs

milde--- via Docutils-checkins <[email protected]> Tue, 16 Dec 2025 17:39:49 +0000
Newsgroups gmane.text.docutils.cvs
Message-ID <[email protected]>
Revision: 10273
          http://sourceforge.net/p/docutils/code/10273
Author:   milde
Date:     2025-12-16 17:39:48 +0000 (Tue, 16 Dec 2025)
Log Message:
-----------
More documentation fixes.

Less confusing example for auto-numbered footnote reference
in the rST specification.

Check and fix spelling in enhancement proposal 10.

Modified Paths:
--------------
    trunk/docutils/docs/eps/ep-010.rst
    trunk/docutils/docs/ref/rst/restructuredtext.rst

Modified: trunk/docutils/docs/eps/ep-010.rst
===================================================================
--- trunk/docutils/docs/eps/ep-010.rst	2025-12-14 13:20:59 UTC (rev 10272)
+++ trunk/docutils/docs/eps/ep-010.rst	2025-12-16 17:39:48 UTC (rev 10273)
@@ -29,7 +29,7 @@
 below 1.0 (widely seen as an indicator of "beta" status of a project).
 
 The current `Docutils Project Policies`_ section on `version
-identifcation`_ concentrates on the formal definition of the version
+identification`_ concentrates on the formal definition of the version
 specifier but leaves open what consists a "major change in the design
 or API".
 
@@ -70,7 +70,7 @@
   - re-implementations of the `reStructuredText specification`_,
     e.g. Pandoc_ or Text-Restructured_ (prest).
 
-A person may belong to more than one of these catgories.
+A person may belong to more than one of these categories.
 
 .. _Sphinx: https://www.sphinx-doc.org/
 .. _rsted: https://github.com/anru/rsted
@@ -117,7 +117,7 @@
   .. html4css1.css, minimal.css, docutils.sty (LaTeX), styles.odt
 
 * the interface to custom stylesheets -- elements, macros and classes
-  used by writers to represent doctree_ nodes in the output format.
+  used by writers to represent Doctree_ nodes in the output format.
 
 Exemptions:
   Python objects, stylesheets and templates can explicitly "opt-out" of
@@ -246,12 +246,12 @@
   * Use "private" or "internal"?
 
 * Declare only objects included in the ``__all__`` attribute of their
-  parent objects as public rsp. explicitely list all public objects in
+  parent objects as public resp. explicitly list all public objects in
   ``__all__`` attribute of their parents?
 
   This would hide private objects from `pydoc` help on the parent objects.
 
-* Define a minimum deprecation time similar to Docbook__? E.g.
+* Define a minimum deprecation time similar to DocBook__? E.g.
 
     * A "major" release may contain backward-incompatible changes if:
 
@@ -281,7 +281,7 @@
 .. _Docutils Design Specification: ../peps/pep-0258.html
 .. _Docutils Project Policies: ../dev/policies.html
 .. _version specifier:
-.. _version identifcation:
+.. _version identification:
     ../dev/policies.html#version-identification
 .. _backwards compatibility policy:
     ../dev/policies.html#backwards-compatibility-policy

Modified: trunk/docutils/docs/ref/rst/restructuredtext.rst
===================================================================
--- trunk/docutils/docs/ref/rst/restructuredtext.rst	2025-12-14 13:20:59 UTC (rev 10272)
+++ trunk/docutils/docs/ref/rst/restructuredtext.rst	2025-12-16 17:39:48 UTC (rev 10273)
@@ -3004,7 +3004,8 @@
     Please RTFM [1]_. [#]_
 
     .. [1] Read The Fine Manual
-    .. [#] See "footnotes_" for the format of the *footnote label*.
+    .. [#] Life is too short for man pages,
+       and occasionally much too short without them.
 
 `Inline markup recognition rules`_ may require whitespace in front of the
 footnote reference. To remove the whitespace from the output, use an

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