8000 PEP 554: Fix citation references by hugovk · Pull Request #2644 · python/peps · GitHub
[go: up one dir, main page]
Skip to content

PEP 554: Fix citation references #2644

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 14, 2022
Merged

PEP 554: Fix citation references #2644

merged 4 commits into from
Jun 14, 2022

Conversation

hugovk
Copy link
Member
@hugovk hugovk commented Jun 11, 2022 
pep-0554.rst:1709: WARNING: Citation [nathaniel-asyncio] is not referenced.
pep-0554.rst:1712: WARNING: Citation [extension-docs] is not referenced.

Fixed by converting to inline links.

pep-0554.rst:1645: WARNING: Citation [CSP] is not referenced.

This citation was added in #419.

The text uses:

`Communicating Sequential Processes`_ (CSP)

and:

.. _Communicating Sequential Processes:

.. [CSP]
   https://en.wikipedia.org/wiki/Communicating_sequential_processes
   https://github.com/futurecore/python-csp

So let's change this to a single citation:

Communicating Sequential Processes [CSP]_

and:

.. [CSP]
   https://en.wikipedia.org/wiki/Communicating_sequential_processes
   https://github.com/futurecore/python-csp
pep-0554.rst:1677: WARNING: Citation [mp-conn] is not referenced.

This citation was added in #424, but removed/orphaned in #1390.

Let's remove the orphan.

pep-0554.rst:1686: WARNING: Citation [main-thread] is not referenced.

Similarly, added in #426 and removed/orphaned in #944.

@hugovk hugovk added the bug label Jun 11, 2022
ericsnowcurrently
ericsnowcurrently requested changes Jun 13, 2022
View reviewed changes
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.

Please leave orphaned references. The linked information still captures relevant information. It's fine if they are turned into bullets, or something similar, in the References section.

Other than that, LGTM.

@hugovk hugovk force-pushed the pep554-fix-warnings branch from 76e30ec to 5709966 Compare June 13, 2022 18:15
@hugovk
Copy link
Member Author
hugovk commented Jun 13, 2022

Updated! How does this look?

image

https://pep-previews--2644.org.readthedocs.build/pep-0554/#references

ericsnowcurrently
ericsnowcurrently approved these changes Jun 14, 2022
View reviewed changes
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 for the improvements!

@hugovk
Copy link
Member Author
hugovk commented Jun 14, 2022

Thanks for the reviews!

@hugovk hugovk merged commit a2a0afd into python:main Jun 14, 2022
@hugovk hugovk deleted the pep554-fix-warnings branch June 14, 2022 17:27
@erlend-aasland erlend-aasland mentioned this pull request Jun 27, 2022
Closed
@hugovk hugovk mentioned this pull request Jul 2, 2022
Merged
@hugovk hugovk mentioned this pull request Jul 15, 2022
Merged
@hugovk hugovk mentioned this pull request Aug 7, 2022
Merged
@hugovk hugovk mentioned this pull request Jan 14, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericsnowcurrently ericsnowcurrently ericsnowcurrently approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hugovk @ericsnowcurrently @AA-Turner
0