gh-89554: Document socket.SocketType as a class#150683
Conversation
|
For context, I am aware of gh-88427 (the |
Documentation build overview
4 files changed± library/array.html± library/socket.html± whatsnew/3.16.html± whatsnew/changelog.html |
79787b0 to
0ad690a
Compare
|
Backward-compatibility check. No independent |
|
|
||
|
|
||
| .. data:: SocketType | ||
| .. class:: SocketType |
There was a problem hiding this comment.
You should move the declaration at https://docs.python.org/dev/library/socket.html#socket-objects and convert methods documentation to .. method: format.
…cription 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 pythongh-88427.
0ad690a to
d89fe9f
Compare
| ``isinstance(socket(...), SocketType)`` is true, but ``SocketType`` is not | ||
| the same as ``type(socket(...))``, which is :class:`~socket.socket` itself. | ||
|
|
||
| Socket objects have the following methods. Except for |
There was a problem hiding this comment.
For the methods below, you should add an indentation of 3 spaces, and replace .. method:: socket.xxx(...) with .. method:: xxx(...) (remove socket. prefix).
socket.SocketTypeis a class, but the documentation marks it with the.. data::directive, so:class:cross-references to it cannot resolve against a py:class target.This switches the entry to
.. class::. It also corrects the description:SocketTypeis re-exported from_socketas an alias of_socket.socket, the base class ofsocket.socket, soisinstance(socket(...), SocketType)is true whiletype(socket(...))issocket.socketitself. The current wording, "the same astype(socket(...))", is the misleading text reported in gh-88427.This overlaps with #93288, which corrects the same sentence but keeps
.. data::. This PR combines that wording fix with the role fix.Refs: gh-89554, gh-88427. Documentation-only change, so no
Misc/NEWSentry (skip news).This file is not covered by CODEOWNERS, so cc @vstinner, who reviews most socket changes.