Skip to content

PEP 366, 395, 413, 426, 430, 440, 531, 535, 3150: Fix footnotes - #2794

Merged
hugovk merged 17 commits into
python:mainfrom
hugovk:fix-footnotes
Sep 16, 2022
Merged

hugovk merged 17 commits into
python:mainfrom
hugovk:fix-footnotes

Conversation

@hugovk

@hugovk hugovk commented Sep 15, 2022 •

Copy link
Copy Markdown
Member

Fix these warnings:

pep-0366.txt:136: WARNING: Footnote [4] is not referenced.
pep-0395.txt:727: WARNING: Footnote [4] is not referenced.
pep-0413.txt:916: WARNING: Footnote [2] is not referenced.
pep-0426.txt:1510: WARNING: Footnote [1] is not referenced.
pep-0430.txt:208: WARNING: Footnote [1] is not referenced.
pep-0430.txt:211: WARNING: Footnote [2] is not referenced.
pep-0430.txt:214: WARNING: Footnote [3] is not referenced.
pep-0440.txt:1559: WARNING: Footnote [1] is not referenced.
pep-0440.txt:1565: WARNING: Footnote [3] is not referenced.
pep-0440.txt:1583: WARNING: Footnote [9] is not referenced.
pep-0531.txt:634: WARNING: Footnote [4] is not referenced.
pep-0531.txt:637: WARNING: Footnote [5] is not referenced.
pep-0531.txt:640: WARNING: Footnote [6] is not referenced.
pep-0535.txt:182: WARNING: Footnote [1] is not referenced.
pep-3150.txt:753: WARNING: Footnote [5] is not referenced.
pep-3150.txt:768: WARNING: Footnote [10] is not referenced.

Details

PEP 366:

  • Fix footnotes references
  • Remove redundant emacs metadata
  • Update BPO redirects to GH

PEP 395:

  • Convert unused footnote to bullets
  • Convert footnotes into inline links
  • Remove redundant emacs metadata

PEP 413:

  • Fix footnote reference
  • Remove redundant emacs metadata
  • Replace broken link with contemporary Wayback Machine link

PEP 426:

  • Convert unused footnote to bullets
  • Update link redirects
  • Remove redundant emacs metadata

PEP 430:

  • Fix footnote references

PEP 440:

  • Convert unused footnote to bullets
  • Convert footnotes into inline links
  • Fix links
  • Remove redundant emacs metadata

PEP 531:

  • Fix footnote references
  • Remove redundant emacs metadata

PEP 535:

  • Fix footnote references
  • Remove redundant emacs metadata

PEP 3150:

  • Convert unused footnote to bullets
  • Convert footnotes into inline links
  • Update link redirects
  • Remove redundant emacs metadata

Previews

@hugovk hugovk added the bug label Sep 15, 2022
@hugovk hugovk changed the title PEP 366: Fix footnotes references and remove redundant emacs metadata PEP 366, 395, 413, 426, 430, 440, 531, 535, 3150: Fix footnotes Sep 15, 2022

@CAM-Gerlach CAM-Gerlach left a comment

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 checked through the source changes and spot checked the rendered versions and they LGTM overall, but the bulleted inline-linked items did look kind of strange alongside the numbered footnotes with raw links. Its not perfect (we probably should also tweak the vertical margins of things at some point, not just here but a few other places could use them too), but converting the footnotes that are just links with a title to actual inline links improves this a lot and makes them more consistent and coherent, as well as being cleaner and taking up less space overall. Do you think you could do that at least for the ones where you added bulleted references?

image

vs.

image

@hugovk

hugovk commented Sep 15, 2022

Copy link
Copy Markdown
Member Author

Good idea, I'll update them.

@CAM-Gerlach CAM-Gerlach left a comment

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.

Thanks, looks pretty good—one thing though, the interleaved bullets and footnotes are a little confusing to me, as it looks like the bulleted items are sub-items of the footnotes. Could you maybe just move the non-numbered footnote bulletted items to the end after the footnotes?

@hugovk

hugovk commented Sep 15, 2022

Copy link
Copy Markdown
Member Author

Done!

@CAM-Gerlach CAM-Gerlach left a comment

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.

LGTM, thanks @hugovk !

@hugovk

hugovk commented Sep 16, 2022

Copy link
Copy Markdown
Member Author

Thanks for the reviews!

@hugovk
hugovk merged commit 6816088 into python:main Sep 16, 2022
@hugovk
hugovk deleted the fix-footnotes branch September 16, 2022 05:15
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.

2 participants