FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.12] gh-101100: Fix sphinx warnings in `library/asyncio-eventloop.rst` (GH-111222) by miss-islington · Pull Request #111469 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

[3.12] gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst (GH-111222) #111469

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

Merged
willingc merged 1 commit into from
Oct 29, 2023
Conversation 0 Commits 1 Checks 0 Files changed
Merged

[3.12] gh-101100: Fix sphinx warnings in library/asyncio-eventloop.rst (GH-111222) #111469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (2) dotfile  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
14 changes: 8 additions & 6 deletions Doc/library/asyncio-eventloop.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -1888,7 +1890,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
Expand Down
7 changes: 7 additions & 0 deletions Doc/library/socket.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -380,6 +385,8 @@ Constants

.. versionadded:: 3.2

.. _socket-unix-constants:

.. data:: SO_*
SOMAXCONN
MSG_*
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ Doc/library/__future__.rst
Doc/library/abc.rst
Doc/library/aifc.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
Expand Down
Back | FazBrowse Home | New Git URL