Skip to content

gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst #111222

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
Oct 29, 2023
Merged

gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst #111222

merged 4 commits into from
Oct 29, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Oct 23, 2023 •
edited by github-actions bot
Loading

Before:

/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:512: WARNING: py:const reference target not found: socket.TCP_NODELAY
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:581: WARNING: py:const reference target not found: socket.SO_REUSEPORT
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:609: WARNING: py:const reference target not found: sockets.SO_REUSEADDR
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:617: WARNING: py:const reference target not found: sockets.SO_REUSEPORT
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:702: WARNING: py:const reference target not found: socket.AF_UNSPEC
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:758: WARNING: py:const reference target not found: socket.TCP_NODELAY
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:1891: WARNING: py:data reference target not found: SIGINT
/Users/sobolev/Desktop/cpython/Doc/library/asyncio-eventloop.rst:1891: WARNING: py:data reference target not found: SIGTERM

So, what I did?

  1. I've added unix-constants reference, better name is appreciated, because not all constants under TCP_* are explicitly documented. I don't think that there's clean a way to do that
  2. I've also documented AF_UNSPEC, because it is rather special. I took the wording from https://man7.org/linux/man-pages/man3/getaddrinfo.3.html

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

@sobolevn sobolevn requested review from hugovk and AA-Turner October 23, 2023 16:40
@bedevere-app bedevere-app bot mentioned this pull request Oct 23, 2023
Open
@sobolevn sobolevn added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Oct 23, 2023
hugovk
hugovk reviewed Oct 24, 2023
View reviewed changes
hugovk
hugovk reviewed Oct 24, 2023
View reviewed changes
@willingc willingc merged commit 46389c3 into python:main Oct 29, 2023
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2023
@sobolevn @hugovk @miss-islington
pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rs…
bb975db 
…t` (pythonGH-111222)

* pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 29, 2023

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2023
@sobolevn @hugovk @miss-islington
pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rs…
0dab1e2 
…t` (pythonGH-111222)

* pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 29, 2023
@bedevere-app
Copy link

bedevere-app bot commented Oct 29, 2023

GH-111470 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 Oct 29, 2023
willingc pushed a commit that referenced this pull request Oct 29, 2023
@miss-islington @sobolevn @hugovk
[3.11] gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.r…
a10fc66 
…st` (GH-111222) (#111470)

gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)

* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst



* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
willingc pushed a commit that referenced this pull request Oct 29, 2023
@miss-islington @sobolevn @hugovk
[3.12] gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.r…
577c808 
…st` (GH-111222) (#111469)

gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222)

* gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst



* Update asyncio-eventloop.rst

* Update socket.rst

---------

(cherry picked from commit 46389c3)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
FullteaR pushed a commit to FullteaR/cpython that referenced this pull request Nov 3, 2023
@sobolevn @hugovk @FullteaR
pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rs…
226894f 
…t` (pythonGH-111222)

* pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

* Update asyncio-eventloop.rst

* Update socket.rst

---------

Co-authored-by: Hugo van Kemenade <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@sobolevn @hugovk @aisk
pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rs…
5c5b82c 
…t` (pythonGH-111222)

* pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

* Update asyncio-eventloop.rst

* Update socket.rst

---------

Co-authored-by: Hugo van Kemenade <[email protected]>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@sobolevn @hugovk @Glyphack
pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rs…
d772055 
…t` (pythonGH-111222)

* pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst`

* Update Doc/library/socket.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

* Update asyncio-eventloop.rst

* Update socket.rst

---------

Co-authored-by: Hugo van Kemenade <[email protected]>
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

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

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

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

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

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

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sobolevn @hugovk @willingc