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 520: Fix citation references #2637

Merged
merged 6 commits into from
Jun 9, 2022
Merged

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jun 8, 2022

peps/pep-0520.txt:416: WARNING: Citation [nick_concern] is not referenced.

The [nick_concern_] reference source was deleted in a9ed29c (#35).

Let's delete this orhpan to fix a Sphinx warning.


peps/pep-0520.txt:419: WARNING: Citation [orig] is not referenced.
peps/pep-0520.txt:422: WARNING: Citation [followup1] is not referenced.
peps/pep-0520.txt:425: WARNING: Citation [followup2] is not referenced.

These were added in the very first commit (9a5e309) and were orphans from the start.

Let's convert them into a bullet list.


The final reference (to the implementation on BPO) doesn't cause a warning, but let's switch it into a direct hyperlink to GH (re: #2130).

The [nick_concern_] reference source was deleted in
python@a9ed29c
(python#35).

Let's delete the redundant reference target to fix a Sphinx warning.
pep-0520.txt Outdated Show resolved Hide resolved
pep-0520.txt Outdated Show resolved Hide resolved
pep-0520.txt Outdated Show resolved Hide resolved
pep-0520.txt Outdated Show resolved Hide resolved
pep-0520.txt Outdated Show resolved Hide resolved
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner changed the title PEP 520: fix build warnings PEP 520: Fix citation references Jun 8, 2022
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.

Thanks for this update, @hugovk! I'm mostly fine. My only request is that you move the "nick_concern" entry into the new list instead of removing it.

pep-0520.txt Show resolved Hide resolved
pep-0520.txt Show resolved Hide resolved
pep-0520.txt Show resolved Hide resolved
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

@hugovk hugovk merged commit 9ef0bfe into python:main Jun 9, 2022
@hugovk hugovk deleted the pep520-fix-warnings branch June 9, 2022 19:04
@hugovk hugovk added the bug label Jun 9, 2022
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