[Python-checkins] [doc] Fix gethostbyname_ex description (GH-28700)
ambv
webhook-mailer at python.org
Tue Oct 5 12:53:43 EDT 2021
https://github.com/python/cpython/commit/4103280b83e1419bef535a42813d6dbe83bfe880
commit: 4103280b83e1419bef535a42813d6dbe83bfe880
branch: main
author: Andre Delfino <adelfino at gmail.com>
committer: ambv <lukasz at langa.pl>
date: 2021-10-05T18:53:35+02:00
summary:
[doc] Fix gethostbyname_ex description (GH-28700)
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't.
files:
M Doc/library/socket.rst
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 397ba54733ca8..27ad5c7fd1d91 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
More information about the Python-checkins
mailing list