]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.14] gh-89554: Document socket.SocketType as a class (#150683) (#151245)
authorVictor Stinner <vstinner@python.org>
Wed, 10 Jun 2026 13:51:29 +0000 (15:51 +0200)
committerGitHub <noreply@github.com>
Wed, 10 Jun 2026 13:51:29 +0000 (15:51 +0200)
commit4ef6a375a15adf76361a73f3c7074350e23e53ba
tree32d5f074d935e1f31fc363e328a52424ea657d90
parentba6b3ce8c883ca75f05e3296af10ae9effdbab35
[3.14] gh-89554: Document socket.SocketType as a class (#150683) (#151245)

gh-89554: Document socket.SocketType as a class (#150683)

socket.SocketType is a class (re-exported from _socket as an alias of
_socket.socket, the base class of socket.socket), but was documented with
the ".. data::" directive, so ":class:" cross-references to it cannot
resolve against a py:class target.

Switch the entry to ".. class::", correct the misleading description
(SocketType is the base class of the socket type, not "type(socket(...))"
which is socket.socket; addresses gh-88427), move it into the Socket
Objects section, and document the socket object methods and attributes
nested under the socket class, dropping the redundant "socket." prefix.

(cherry picked from commit a621e8ad811e7d51d69b0969a2bd07888a02db1e)

Co-authored-by: Bernát Gábor <gaborjbernat@gmail.com>
Doc/library/socket.rst