Repository navigation
Commit d89fe9f
committed
gh-89554: Document socket.SocketType as a class and fix its description
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 description (SocketType is
the base class of the socket type, not "type(socket(...))" which is
socket.socket), and move the declaration into the Socket Objects section
next to the socket object methods. This addresses the misleading wording
reported in gh-88427.1 parent 2f8f569 commit d89fe9f
1 file changed
Lines changed: 7 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1025,12 +1025,6 @@ The following functions all create :ref:`socket objects <socket-objects>`. | |||
| 1025 | 1025 | .. versionadded:: 3.3 | |
| 1026 | 1026 | ||
| 1027 | 1027 | ||
| 1028 | - .. data:: SocketType | ||
| 1029 | - | ||
| 1030 | - This is a Python type object that represents the socket object type. It is the | ||
| 1031 | - same as ``type(socket(...))``. | ||
| 1032 | - | ||
| 1033 | - | ||
| 1034 | 1028 | Other functions | |
| 1035 | 1029 | ''''''''''''''' | |
| 1036 | 1030 | ||
@@ -1538,6 +1532,13 @@ The :mod:`!socket` module also offers various network-related services: | |||
| 1538 | 1532 | Socket Objects | |
| 1539 | 1533 | -------------- | |
| 1540 | 1534 | ||
| 1535 | + .. class:: SocketType | ||
| 1536 | + | ||
| 1537 | + The base class of the :class:`~socket.socket` type, re-exported from | ||
| 1538 | + :mod:`!_socket`. An instance check such as | ||
| 1539 | + ``isinstance(socket(...), SocketType)`` is true, but ``SocketType`` is not | ||
| 1540 | + the same as ``type(socket(...))``, which is :class:`~socket.socket` itself. | ||
| 1541 | + | ||
| 1541 | 1542 | Socket objects have the following methods. Except for | |
| 1542 | 1543 | :meth:`~socket.makefile`, these correspond to Unix system calls applicable | |
| 1543 | 1544 | to sockets. | |
0 commit comments