]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-40635: Fix getfqdn() docstring and docs (GH-27971)
authorandrei kulakov <andrei.avk@gmail.com>
Thu, 26 Aug 2021 18:40:28 +0000 (14:40 -0400)
committerGitHub <noreply@github.com>
Thu, 26 Aug 2021 18:40:28 +0000 (20:40 +0200)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
Doc/library/socket.rst
Lib/socket.py

index 95c7d7e0699f015167a194b7f9aff3626fface15..d668c6b7972717ba4e69254f3a32969ddd16246f 100755 (executable)
@@ -808,8 +808,9 @@ The :mod:`socket` module also offers various network-related services:
    it is interpreted as the local host.  To find the fully qualified name, the
    hostname returned by :func:`gethostbyaddr` is checked, followed by aliases for the
    host, if available.  The first name which includes a period is selected.  In
-   case no fully qualified domain name is available, the hostname as returned by
-   :func:`gethostname` is returned.
+   case no fully qualified domain name is available and *name* was provided,
+   it is returned unchanged.  If *name* was empty or equal to ``'0.0.0.0'``,
+   the hostname from :func:`gethostname` is returned.
 
 
 .. function:: gethostbyname(hostname)
index a64ae400ce988309589358072158c676895da18a..ef82c496cb85a4e3101b1b1ad1a7af1736a60a7b 100755 (executable)
@@ -782,8 +782,9 @@ def getfqdn(name=''):
     An empty argument is interpreted as meaning the local host.
 
     First the hostname returned by gethostbyaddr() is checked, then
-    possibly existing aliases. In case no FQDN is available, hostname
-    from gethostname() is returned.
+    possibly existing aliases. In case no FQDN is available and `name`
+    was given, it is returned unchanged. If `name` was empty or '0.0.0.0',
+    hostname from gethostname() is returned.
     """
     name = name.strip()
     if not name or name == '0.0.0.0':