]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[doc] Fix gethostbyname_ex description (GH-28700)
authorAndre Delfino <adelfino@gmail.com>
Tue, 5 Oct 2021 16:53:35 +0000 (13:53 -0300)
committerGitHub <noreply@github.com>
Tue, 5 Oct 2021 16:53:35 +0000 (18:53 +0200)
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't.

Doc/library/socket.rst

index 397ba54733ca8c3b41fdd01c5816c9954cdebfb3..27ad5c7fd1d91f2b7927791ac7f960591edf49ba 100755 (executable)
@@ -827,8 +827,8 @@ The :mod:`socket` module also offers various network-related services:
 .. function:: gethostbyname_ex(hostname)
 
    Translate a host name to IPv4 address format, extended interface. Return a
-   triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the primary
-   host name responding to the given *ip_address*, *aliaslist* is a (possibly
+   triple ``(hostname, aliaslist, ipaddrlist)`` where *hostname* is the host's
+   primary host name, *aliaslist* is a (possibly
    empty) list of alternative host names for the same address, and *ipaddrlist* is
    a list of IPv4 addresses for the same interface on the same host (often but not
    always a single address). :func:`gethostbyname_ex` does not support IPv6 name