Skip to content

gh-71566: Fix SocketType introduction in the socket documentation. #93288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+6 −2
Open

gh-71566: Fix SocketType introduction in the socket documentation. #93288

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d9e9d7
gh-71566: Fix SocketType introduction in the socket documentation.
xiaochen7 May 27, 2022
f7d3261
📜🤖 Added by blurb_it.
blurb-it[bot] May 27, 2022
bfda8d7
delete NEWS
xiaochen7 May 28, 2022
491e69e
apply wording suggestions from Adam Turner
xiaochen7 Jun 7, 2022
08842e1
Merge branch 'main' into gh-71566
willingc Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,8 +826,11 @@ The following functions all create :ref:`socket objects <socket-objects>`.

.. data:: SocketType

This is a Python type object that represents the socket object type. It is the
same as ``type(socket(...))``.
This is the base class for a type object of socket objects, and
``isinstance(socket(...), SocketType)`` returns ``True``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This is the base class for a type object of socket objects, and
``isinstance(socket(...), SocketType)`` returns ``True``.
This is the base class for socket objects, such that
``isinstance(socket(...), SocketType)`` is ``True``.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your professional advice. As we can see, socket.SocketType is the base class for the type object socket.socket. Consider that elsewhere in this document socket object refers to an instance of the type object socket.socket. Wouldn't it be less precise if we just said that SocketType is the base class of socket objects? Looking forward to your more suggestions.


.. versionchanged:: 3.0
SocketType is now the base class for the socket object type.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SocketType is now the base class for the socket object type.
SocketType is the base class for socket objects
rather than being ``type(socket(...))``` directly.



Other functions
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2022-05-27-13-09-54.gh-issue-71566.CF2o12.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update documentation for SocketType to align with its implementation.