From 8dcbf79695989c00b5abd3af7d89728653a9db71 Mon Sep 17 00:00:00 2001 From: Hong Xu Date: Fri, 12 Nov 2021 22:02:04 -0800 Subject: [PATCH] bpo-45772: socket.socket should be a class instead of a function (GH-23960) * 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 --- Doc/library/socket.rst | 2 +- .../next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index b5a4b0cde066fb..9e1f91b1714dd7 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -507,7 +507,7 @@ Creating sockets The following functions all create :ref:`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 index 00000000000000..47679521df30b1 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst @@ -0,0 +1 @@ +``socket.socket`` documentation is corrected to a class from a function.