Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PEP 661: Fix citation references #2698

Merged
merged 4 commits into from
Jul 6, 2022

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jul 2, 2022

pep-0661.rst:323: WARNING: Footnote [5] is not referenced.
pep-0661.rst:324: WARNING: Footnote [6] is not referenced.
pep-0661.rst:325: WARNING: Footnote [7] is not referenced.
pep-0661.rst:326: WARNING: Footnote [8] is not referenced.

These are not referenced in the text. Let's fix by converting to a bullet list (like in #2644).

Let's also convert the remaining references to inline links, per #2130, and remove the redundant emacs metadata.

Preview

https://pep-previews--2698.org.readthedocs.build/pep-0661/

@hugovk hugovk added the bug label Jul 2, 2022
@hugovk hugovk requested a review from taleinat as a code owner July 2, 2022 20:59
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

I usually make indirect external-link references anonymous, to avoid creating duplicate or unintended second-order reference targets, particularly for the rather generic words that are often linked.

Otherwise, LGTM. Thanks @hugovk !

@hugovk
Copy link
Member Author

hugovk commented Jul 5, 2022

Shall I update them to be anonymous? And if so, can you give me an example of the syntax? :)

@CAM-Gerlach
Copy link
Member

Shall I update them to be anonymous? And if so, can you give me an example of the syntax? :)

Up to you, but you just add an extra trailing underscore, so instead of

`link text <https://example.com>`_

you do

`link text <https://example.com>`__

or in this case, instead of

`link text <link-target_>`_

you do

`link text <link-target_>`__

Find/replacing _>`_ with _>`__ should do the trick.

@hugovk
Copy link
Member Author

hugovk commented Jul 6, 2022

Thanks, that could save us some bother later, updated!

@CAM-Gerlach
Copy link
Member

Thanks! I guess we can merge this then ✔️

@CAM-Gerlach CAM-Gerlach merged commit 938c2d2 into python:main Jul 6, 2022
@hugovk hugovk deleted the pep661-fix-footnotes branch July 6, 2022 21:14
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