[Python-checkins] [doc] Fix gethostbyname_ex description (GH-28700) (GH-28743)
ambv
webhook-mailer at python.org
Tue Oct 5 13:22:21 EDT 2021
https://github.com/python/cpython/commit/950b324973a98ec45c21e7e7149415259a045ff7
commit: 950b324973a98ec45c21e7e7149415259a045ff7
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2021-10-05T19:22:14+02:00
summary:
[doc] Fix gethostbyname_ex description (GH-28700) (GH-28743)
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 at gmail.com>
Co-authored-by: Andre Delfino <adelfino at gmail.com>
files:
M Doc/library/socket.rst
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index cc8c5650dec3d..bc8723a90daad 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -814,8 +814,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