Skip to content

Conversation

@sobolevn
Copy link
Member

@sobolevnsobolevn commented Oct 23, 2023

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/

sobolevnand others added 3 commits October 24, 2023 17:48
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@willingcwillingc merged commit 46389c3 into python:mainOct 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
…t` (pythonGH-111222) * pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` * Update Doc/library/socket.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update asyncio-eventloop.rst * Update socket.rst --------- (cherry picked from commit 46389c3) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link

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
…t` (pythonGH-111222) * pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` * Update Doc/library/socket.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update asyncio-eventloop.rst * Update socket.rst --------- (cherry picked from commit 46389c3) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-appbedevere-appbot removed the needs backport to 3.12 only security fixes label Oct 29, 2023
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot 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
…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 <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
willingc pushed a commit that referenced this pull request Oct 29, 2023
…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 <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
FullteaR pushed a commit to FullteaR/cpython that referenced this pull request Nov 3, 2023
…t` (pythonGH-111222) * pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` * Update Doc/library/socket.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update asyncio-eventloop.rst * Update socket.rst --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…t` (pythonGH-111222) * pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` * Update Doc/library/socket.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update asyncio-eventloop.rst * Update socket.rst --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…t` (pythonGH-111222) * pythongh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` * Update Doc/library/socket.rst Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Update asyncio-eventloop.rst * Update socket.rst --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Sign up for freeto 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

@sobolevn@hugovk@willingc