summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-10-05 17:21:25 (GMT)
committerGitHub <noreply@github.com>2021-10-05 17:21:25 (GMT)
commiteb59e2fc111189804be307998a618f186b73e5fa (patch)
treef94cd394ad42fd4ff3fd64897c8b774a5d760b0e
parentd0d29655ffc43d426ad68542d8de8304f7f1346a (diff)
downloadcpython-eb59e2fc111189804be307998a618f186b73e5fa.zip
cpython-eb59e2fc111189804be307998a618f186b73e5fa.tar.gz
cpython-eb59e2fc111189804be307998a618f186b73e5fa.tar.bz2
[doc] Fix gethostbyname_ex description (GH-28700) (GH-28742)
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't. (cherry picked from commit 4103280b83e1419bef535a42813d6dbe83bfe880) Co-authored-by: Andre Delfino <adelfino@gmail.com>
-rwxr-xr-xDoc/library/socket.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 3c81858..b16bf22 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -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