summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorNikita Sobolev <mail@sobolevn.me>2023-10-29 19:31:01 (GMT)
committerGitHub <noreply@github.com>2023-10-29 19:31:01 (GMT)
commit46389c32750f79ab3f398a0132cd002e8a64f809 (patch)
treeb868df8dd9e6344ffc95d1140642f0816507ac45 /Doc
parentfa35b9e89b2e207fc8bae9eb0284260d0d922e7a (diff)
downloadcpython-46389c32750f79ab3f398a0132cd002e8a64f809.zip
cpython-46389c32750f79ab3f398a0132cd002e8a64f809.tar.gz
cpython-46389c32750f79ab3f398a0132cd002e8a64f809.tar.bz2
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 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>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/asyncio-eventloop.rst14
-rw-r--r--Doc/library/socket.rst7
-rw-r--r--Doc/tools/.nitignore1
3 files changed, 15 insertions, 7 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index 5627f0d..3911d2c 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -509,7 +509,7 @@ Opening network connections
.. versionchanged:: 3.6
- The socket option :py:const:`~socket.TCP_NODELAY` is set by default
+ The socket option :ref:`socket.TCP_NODELAY <socket-unix-constants>` is set by default
for all TCP connections.
.. versionchanged:: 3.7
@@ -581,7 +581,7 @@ Opening network connections
* *reuse_port* tells the kernel to allow this endpoint to be bound to the
same port as other existing endpoints are bound to, so long as they all
set this flag when being created. This option is not supported on Windows
- and some Unixes. If the :py:const:`~socket.SO_REUSEPORT` constant is not
+ and some Unixes. If the :ref:`socket.SO_REUSEPORT <socket-unix-constants>` constant is not
defined then this capability is unsupported.
* *allow_broadcast* tells the kernel to allow this endpoint to send
@@ -607,7 +607,8 @@ Opening network connections
.. versionchanged:: 3.8.1
The *reuse_address* parameter is no longer supported, as using
- :py:const:`~sockets.SO_REUSEADDR` poses a significant security concern for
+ :ref:`socket.SO_REUSEADDR <socket-unix-constants>`
+ poses a significant security concern for
UDP. Explicitly passing ``reuse_address=True`` will raise an exception.
When multiple processes with differing UIDs assign sockets to an
@@ -616,7 +617,8 @@ Opening network connections
For supported platforms, *reuse_port* can be used as a replacement for
similar functionality. With *reuse_port*,
- :py:const:`~sockets.SO_REUSEPORT` is used instead, which specifically
+ :ref:`socket.SO_REUSEPORT <socket-unix-constants>`
+ is used instead, which specifically
prevents processes with differing UIDs from assigning sockets to the same
socket address.
@@ -758,7 +760,7 @@ Creating network servers
.. versionchanged:: 3.6
Added *ssl_handshake_timeout* and *start_serving* parameters.
- The socket option :py:const:`~socket.TCP_NODELAY` is set by default
+ The socket option :ref:`socket.TCP_NODELAY <socket-unix-constants>` is set by default
for all TCP connections.
.. versionchanged:: 3.11
@@ -1896,7 +1898,7 @@ Set signal handlers for SIGINT and SIGTERM
(This ``signals`` example only works on Unix.)
-Register handlers for signals :py:data:`SIGINT` and :py:data:`SIGTERM`
+Register handlers for signals :const:`~signal.SIGINT` and :const:`~signal.SIGTERM`
using the :meth:`loop.add_signal_handler` method::
import asyncio
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 14f11b4..9ff1aa3 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -352,6 +352,11 @@ Constants
defined then this protocol is unsupported. More constants may be available
depending on the system.
+.. data:: AF_UNSPEC
+
+ :const:`AF_UNSPEC` means that
+ :func:`getaddrinfo` should return socket addresses for any
+ address family (either IPv4, IPv6, or any other) that can be used.
.. data:: SOCK_STREAM
SOCK_DGRAM
@@ -380,6 +385,8 @@ Constants
.. versionadded:: 3.2
+.. _socket-unix-constants:
+
.. data:: SO_*
SOMAXCONN
MSG_*
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 4433b4d..105e00d 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -30,7 +30,6 @@ Doc/howto/logging.rst
Doc/howto/urllib2.rst
Doc/library/abc.rst
Doc/library/ast.rst
-Doc/library/asyncio-eventloop.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst
Doc/library/asyncio-stream.rst