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 554: Convert unreferenced footnote to bullet point #3189

Merged
merged 3 commits into from
Jul 26, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jun 28, 2023

Fix this warning:

pep-0554.rst:1335: WARNING: Citation [petr-c-ext] is not referenced.

The reference to the footnote was removed in #3067, let's also remove the footnote itself. Alternatively, we could convert it a bulleted footnote, there's already a couple of those.

Also remove redundant emacs metadata.


📚 Documentation preview 📚: https://pep-previews--3189.org.readthedocs.build/pep-0554/

@hugovk hugovk added the bug label Jun 28, 2023
@ericsnowcurrently
Copy link
Member

I'd rather leave the links in the document. Is there a way we can do so without getting a warning? Some sort of "Related Resources" section?

@AA-Turner
Copy link
Member

We could disable citation referencing warnings, though that is a whole-project setting.

Alternativley, this document already has mp-conn and main-thread at the bottom of the citations list which aren't marked up as citations, as they have no references -- perhaps we could convert petr-c-ext to that format?

A

@hugovk
Copy link
Member Author

hugovk commented Jul 26, 2023

Yes, we can definitely turn it into a regular bullet point, I'll update the PR 👍

@hugovk hugovk changed the title PEP 554: Remove unreferenced footnote PEP 554: Convert unreferenced footnote to bullet point Jul 26, 2023
Copy link
Member

@ericsnowcurrently ericsnowcurrently left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks!

@hugovk hugovk merged commit 1453e26 into python:main Jul 26, 2023
@hugovk hugovk deleted the pep554-fix-warning branch July 26, 2023 15:24
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.

3 participants