Skip to content

PEP 484: Fix citation references #2638

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

Merged
merged 6 commits into from
Jun 10, 2022
Merged

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jun 8, 2022

Fix some Sphinx build warnings.

(for readability, paths trimmed in warnings shown here)


pep-0484.txt:2490: WARNING: Citation [peps] is not referenced.

This was a misplaced underscore, now fixed.


pep-0484.txt:2463: WARNING: duplicate citation mypy, other instance in pep-0482.txt

The exact same citation is already defined in pep-482.txt, Sphinx uses that one.


pep-0484.txt:2475: WARNING: duplicate citation pyflakes, other instance in pep-0482.txt
pep-0484.txt:2478: WARNING: duplicate citation pylint, other instance in pep-0482.txt

These aren't actually used in this file, we can delete them.


Also remove the redundant emacs metadata from the end of the file.

@hugovk hugovk requested review from gvanrossum and ambv as code owners June 8, 2022 20:45
@AA-Turner
Copy link
Member

The exact same citation is already defined in pep-482.txt, Sphinx uses that one.

I think it would be good to have each PEP be standalone -- should PEP 482 ever change, we might inadvertently introduce build errors on this PEP.

Probably better to turn it into an inline link here, as the rendering is already odd as the markup is a reST citation rather than a reST footnote (which must either begin with # or be numeric):

image

A

@AA-Turner
Copy link
Member

AA-Turner commented Jun 8, 2022

Actually, all the citations in PEP-484 have no content beyond links -- I'd support inlining them all, especially as it is a reasonably well referenced document.

A

@hugovk
Copy link
Member Author

hugovk commented Jun 8, 2022

Updated!

@AA-Turner AA-Turner self-requested a review June 8, 2022 22:08
@AA-Turner
Copy link
Member

Line 49 needs to be similarly updated (can't add a review comment)

A

@hugovk
Copy link
Member Author

hugovk commented Jun 9, 2022

Thanks, done!

@hugovk hugovk added the bug label Jun 9, 2022
@AA-Turner AA-Turner merged commit 85c4c86 into python:main Jun 10, 2022
@hugovk hugovk deleted the pep484-fix-warnings branch June 10, 2022 21:13
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