PEP 1/12: Change name of References section to Footnotes in new PEPs

Author: CAM-Gerlach

pep-0001.txt

@@ -510,7 +510,7 @@ Each PEP should have the following parts/sections:
     ready for consideration are complete and reduces people duplicating
     prior discussion.
 
-12. References -- A collection of footnotes referenced in the PEP, and
+12. Footnotes -- A collection of footnotes referenced in the PEP, and
     a central place to list non-inline hyperlink targets.
 
 13. Copyright/license -- Each new PEP must be placed under a dual license of
@@ -781,8 +781,8 @@ Resources:
 * `Python Developer's Guide <https://devguide.python.org/>`_
 
 
-References and Footnotes
-========================
+Footnotes
+=========
 
 .. [1] This historical record is available by the normal git commands
    for retrieving older revisions, and can also be browsed via HTTP here:

pep-0012.rst

@@ -137,7 +137,7 @@ directions below.
   prohibition of tab characters and the indentation requirements.
   See "Suggested Sections" below for a template of sections to include.
 
-- Update your References section, listing any footnotes and
+- Update your Footnotes section, listing any footnotes and
   non-inline link targets referenced by the text.
 
 - Leave the Emacs stanza at the end of this file alone, including the
@@ -488,7 +488,7 @@ which like the above, renders as:
 
 .. _pydocs: https://docs.python.org/
 
-An explicit target provides the URL.  Put targets in a References section
+An explicit target provides the URL.  Put targets in the Footnotes section
 at the end of the PEP, or immediately after the paragraph with the reference.
 Hyperlink targets begin with two periods and a space (the "explicit
 markup start"), followed by a leading underscore, the reference text,
@@ -562,8 +562,8 @@ followed by the footnote body.  For example:
 
 .. code-block:: rst
 
-    References
-    ==========
+    Footnotes
+    =========
 
     .. [1] Note that the footnote reference is a numbered one.
 
@@ -581,8 +581,8 @@ other characters are allowed).  For example:
 
     Refer to The TeXbook [#TeXbook]_ for more information.
 
-    References
-    ==========
+    Footnotes
+    =========
 
     .. [#TeXbook] Donald Knuth's *The TeXbook*, pages 195 and 196.
 

pep-0012/pep-NNNN.rst

@@ -75,8 +75,8 @@ Open Issues
 [Any points that are still being decided/discussed.]
 
 
-References
-==========
+Footnotes
+=========
 
 [A collection of footnotes referenced in the PEP, and a central place to list non-inline hyperlink targets.]
 

pep2html.py

@@ -496,7 +496,7 @@ def apply(self):
 
 
 class PEPFooter(Transform):
-    """Remove the References section if it is empty when rendered."""
+    """Remove the References/Footnotes section if it is empty when rendered."""
 
     # Set low priority so ref targets aren't removed before they are needed
     default_priority = 999
@@ -511,8 +511,8 @@ def apply(self):
             if not isinstance(section, nodes.section):
                 continue
             title_words = section[0].astext().lower().split()
-            if 'references' in title_words:
-                # Remove references section if there are no displayed
+            if 'references' in title_words or 'footnotes' in title_words:
+                # Remove references/footnotes section if there are no displayed
                 # footnotes (it only has title & link target nodes)
                 if all(isinstance(ref_node, (nodes.title, nodes.target))
                        for ref_node in section):

pep_sphinx_extensions/pep_processor/transforms/pep_footer.py

@@ -9,8 +9,8 @@
 class PEPFooter(transforms.Transform):
     """Footer transforms for PEPs.
 
-     - Removes the References section if it is empty when rendered.
-     - Creates a link to the (GitHub) source text.
+     - Remove the References/Footnotes section if it is empty when rendered.
+     - Create a link to the (GitHub) source text.
 
     Source Link:
         Create the link to the source file from the document source path,
@@ -31,8 +31,8 @@ def apply(self) -> None:
             if not isinstance(section, nodes.section):
                 continue
             title_words = section[0].astext().lower().split()
-            if "references" in title_words:
-                # Remove references section if there are no displayed
+            if "references" in title_words or "footnotes" in title_words:
+                # Remove references/footnotes section if there are no displayed
                 # footnotes (it only has title & link target nodes)
                 to_hoist = []
                 types = set()