[Python-checkins] bpo-45772: socket.socket should be a class instead of a function (GH-23960)

asvetlov webhook-mailer at python.org
Sat Nov 13 01:02:13 EST 2021


https://github.com/python/cpython/commit/4c792f39e688b11c7c19e411ed4f76a7baa44638
commit: 4c792f39e688b11c7c19e411ed4f76a7baa44638
branch: main
author: Hong Xu <hong at topbug.net>
committer: asvetlov <andrew.svetlov at gmail.com>
date: 2021-11-13T08:02:04+02:00
summary:

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.

files:
A Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst
M Doc/library/socket.rst

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 831821bbda77c..d6edc057f5e9c 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -562,7 +562,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
index 0000000000000..47679521df30b
--- /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.



More information about the Python-checkins mailing list