Skip to content

PEP 432: Fix footnotes and syntax highlighting - #2716

Merged
brettcannon merged 3 commits into
python:mainfrom
hugovk:pep432-fix-footnotes
Jul 20, 2022
Merged

brettcannon merged 3 commits into
python:mainfrom
hugovk:pep432-fix-footnotes

Conversation

@hugovk

@hugovk hugovk commented Jul 15, 2022 •

Copy link
Copy Markdown
Member

Fixes these warnings:

pep-0432.txt:1381: WARNING: Footnote [1] is not referenced.
pep-0432.txt:1384: WARNING: Footnote [2] is not referenced.
pep-0432.txt:1387: WARNING: Footnote [3] is not referenced.
pep-0432.txt:1390: WARNING: Footnote [4] is not referenced.
pep-0432.txt:1393: WARNING: Footnote [5] is not referenced.
pep-0432.txt:1396: WARNING: Footnote [6] is not referenced.
pep-0432.txt:1399: WARNING: Footnote [7] is not referenced.
pep-0432.txt:1403: WARNING: Footnote [8] is not referenced.
pep-0432.txt:1406: WARNING: Footnote [9] is not referenced.
pep-0432.txt:1409: WARNING: Footnote [10] is not referenced.

Similar to #2714: the footnotes in the text should be of the form [1]_ not [1_].

Also, as the code blocks are mostly C, set the document default to C (re: PEP 12) instead of Python, with a couple of exceptions for bash/shell:

Before After
image image
image image

Preview

https://pep-previews--2716.org.readthedocs.build/pep-0432/

@brettcannon
brettcannon merged commit dae379c into python:main Jul 20, 2022
@hugovk
hugovk deleted the pep432-fix-footnotes branch July 21, 2022 06:08
@ericsnowcurrently

Copy link
Copy Markdown
Member

Thanks for the fixes.

Comment thread pep-0432.txt
Current numbers on my system for Python 3.7 (as built by the Fedora project)::
Current numbers on my system for Python 3.7 (as built by the Fedora project):

.. code-block:: shell

@CAM-Gerlach CAM-Gerlach Jul 22, 2022 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you meant console here (shell is an alias for bash, and this has the $ prompt and output as in console)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well spotted, I did!

Please see PR #2729 to fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants