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.

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

gh-101100: Fix sphinx warnings in asyncio-task.rst #114469

Merged
merged 2 commits into from
Jan 24, 2024
Merged

gh-101100: Fix sphinx warnings in asyncio-task.rst #114469

merged 2 commits into from
Jan 24, 2024

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jan 23, 2024 •
edited by github-actions bot
Loading

It used to be:

/Users/sobolev/Desktop/cpython2/Doc/library/asyncio-task.rst:837: WARNING: py:const reference target not found: FIRST_COMPLETED
/Users/sobolev/Desktop/cpython2/Doc/library/asyncio-task.rst:840: WARNING: py:const reference target not found: FIRST_EXCEPTION
/Users/sobolev/Desktop/cpython2/Doc/library/asyncio-task.rst:840: WARNING: py:const reference target not found: ALL_COMPLETED
/Users/sobolev/Desktop/cpython2/Doc/library/asyncio-task.rst:846: WARNING: py:const reference target not found: ALL_COMPLETED

📚 Documentation preview 📚: https://cpython-previews--114469.org.readthedocs.build/

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Jan 23, 2024
@bedevere-app bedevere-app bot mentioned this pull request Jan 23, 2024
Open
@sobolevn sobolevn added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jan 23, 2024
@sobolevn @serhiy-storchaka
Update Doc/library/asyncio-task.rst
6d88dc4 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk
hugovk approved these changes Jan 23, 2024
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

serhiy-storchaka
serhiy-storchaka approved these changes Jan 23, 2024
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM.

The drawback is that it renders the module name together with the constant name. But I think that it is not a big deal here. It may be a problem for longer names.

willingc
willingc approved these changes Jan 24, 2024
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks @sobolevn. 🚢

@hugovk hugovk merged commit 1e4f00e into python:main Jan 24, 2024
25 checks passed
@miss-islington-app
Copy link

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 1e4f00ebd8db44a031b61eed0803b4c3d731aed7 3.12

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 24, 2024
@sobolevn @serhiy-storchaka @miss-islington
pythongh-101100: Fix sphinx warnings in asyncio-task.rst (pythonGH-…
0a8fb9f 
…114469)

(cherry picked from commit 1e4f00e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 24, 2024

GH-114518 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Jan 24, 2024
hugovk pushed a commit to hugovk/cpython that referenced this pull request Jan 24, 2024
@sobolevn @serhiy-storchaka @hugovk
[3.12] pythongh-101100: Fix sphinx warnings in asyncio-task.rst (py…
c50cf56 
…thonGH-114469)

(cherry picked from commit 1e4f00e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 24, 2024

GH-114519 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jan 24, 2024
hugovk pushed a commit that referenced this pull request Jan 24, 2024
@miss-islington @sobolevn @serhiy-storchaka
[3.11] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469)…
208db89 
… (#114518)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Jan 24, 2024
@sobolevn @serhiy-storchaka @hugovk
[3.12] pythongh-101100: Fix sphinx warnings in asyncio-task.rst (py…
c59afa1 
…thonGH-114469)

(cherry picked from commit 1e4f00e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
hugovk added a commit that referenced this pull request Jan 24, 2024
@hugovk @sobolevn @serhiy-storchaka
[3.12] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469)…
0c42897 
… (#114519)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@sobolevn sobolevn mentioned this pull request Jan 24, 2024
Merged
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@sobolevn @serhiy-storchaka @aisk
pythongh-101100: Fix sphinx warnings in asyncio-task.rst (python#11…
bae76a5 
…4469)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@sobolevn @serhiy-storchaka @Glyphack
pythongh-101100: Fix sphinx warnings in asyncio-task.rst (python#11…
321697f 
…4469)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@willingc willingc willingc approved these changes

@gvanrossum gvanrossum gvanrossum approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

@kumaraditya303 kumaraditya303 Awaiting requested review from kumaraditya303 kumaraditya303 is a code owner

Assignees

@hugovk hugovk

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sobolevn @hugovk @willingc @gvanrossum @serhiy-storchaka