[Python-checkins] Doc: use "unnumbered" footnotes (GH-98954)

miss-islington webhook-mailer at python.org
Tue Nov 1 09:35:41 EDT 2022


https://github.com/python/cpython/commit/129de5d4a2761b5b29e378e22d6e08d89038d78e
commit: 129de5d4a2761b5b29e378e22d6e08d89038d78e
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-11-01T06:35:34-07:00
summary:

Doc: use "unnumbered" footnotes (GH-98954)


Use unnumbered footnote in this file to avoid reseting the footnotes numbering.

Example: when building the tutorial into a PDF and using `latex_show_urls = "footnotes"`; this footnote become the number 8. However, without this change, the footnote shows the number 1.
(cherry picked from commit f042646595d1cdd2ecdc15222b1766f746d010f0)

Co-authored-by: Manuel Kaufmann <humitos at gmail.com>

files:
M Doc/tutorial/datastructures.rst

diff --git a/Doc/tutorial/datastructures.rst b/Doc/tutorial/datastructures.rst
index 12b00be3793e..c8e89d9b79bd 100644
--- a/Doc/tutorial/datastructures.rst
+++ b/Doc/tutorial/datastructures.rst
@@ -122,7 +122,7 @@ An example that uses most of the list methods::
 
 You might have noticed that methods like ``insert``, ``remove`` or ``sort`` that
 only modify the list have no return value printed -- they return the default
-``None``. [1]_  This is a design principle for all mutable data structures in
+``None``. [#]_  This is a design principle for all mutable data structures in
 Python.
 
 Another thing you might notice is that not all data can be sorted or
@@ -731,5 +731,5 @@ interpreter will raise a :exc:`TypeError` exception.
 
 .. rubric:: Footnotes
 
-.. [1] Other languages may return the mutated object, which allows method
+.. [#] Other languages may return the mutated object, which allows method
        chaining, such as ``d->insert("a")->remove("b")->sort();``.



More information about the Python-checkins mailing list