]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-129994: update docs when using `dualstack_ipv6` in `socket.create_server...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 30 Mar 2025 10:07:08 +0000 (12:07 +0200)
committerGitHub <noreply@github.com>
Sun, 30 Mar 2025 10:07:08 +0000 (12:07 +0200)
gh-129994: update docs when using `dualstack_ipv6` in `socket.create_server` (GH-129996)
(cherry picked from commit 044a1e13d5cfc91b0a8774e936877e91cbac3a16)

Co-authored-by: Alexander Ershov <150328014+AEErshov@users.noreply.github.com>
Doc/library/socket.rst

index 12f95b839a948eff70f3cd5afefd37ee8c454f40..e5baa3a002a01e782b1f191633fa388dd639c913 100644 (file)
@@ -838,10 +838,10 @@ The following functions all create :ref:`socket objects <socket-objects>`.
    , a default reasonable value is chosen.
    *reuse_port* dictates whether to set the :data:`SO_REUSEPORT` socket option.
 
-   If *dualstack_ipv6* is true and the platform supports it the socket will
-   be able to accept both IPv4 and IPv6 connections, else it will raise
-   :exc:`ValueError`. Most POSIX platforms and Windows are supposed to support
-   this functionality.
+   If *dualstack_ipv6* is true, *family* is :data:`AF_INET6` and the platform
+   supports it the socket will be able to accept both IPv4 and IPv6 connections,
+   else it will raise :exc:`ValueError`. Most POSIX platforms and Windows are
+   supposed to support this functionality.
    When this functionality is enabled the address returned by
    :meth:`socket.getpeername` when an IPv4 connection occurs will be an IPv6
    address represented as an IPv4-mapped IPv6 address.