]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.9] bpo-45772: socket.socket should be a class instead of a function (GH-23960...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sat, 13 Nov 2021 06:29:01 +0000 (22:29 -0800)
committerGitHub <noreply@github.com>
Sat, 13 Nov 2021 06:29:01 +0000 (22:29 -0800)
* [bpo-45772](): socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f39e688b11c7c19e411ed4f76a7baa44638)

Co-authored-by: Hong Xu <hong@topbug.net>
Automerge-Triggered-By: GH:asvetlov
Doc/library/socket.rst
Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst [new file with mode: 0644]

index db94a2a1245755f5c6632d7bfcfebc75b2b1f996..f0a1338e2b85e616e50e72d0f96ba585dcfe6430 100755 (executable)
@@ -552,7 +552,7 @@ Creating sockets
 The following functions all create :ref:`socket objects <socket-objects>`.
 
 
-.. function:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
+.. class:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
 
    Create a new socket using the given address family, socket type and protocol
    number.  The address family should be :const:`AF_INET` (the default),
diff --git a/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst b/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst
new file mode 100644 (file)
index 0000000..4767952
--- /dev/null
@@ -0,0 +1 @@
+``socket.socket`` documentation is corrected to a class from a function.