gh-71566: Fix SocketType introduction in the socket documentation. #93288
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
You don't need NEWS, please delete it. A |
AA-Turner
added
needs backport to 3.10
AA-Turner
requested changes
May 27, 2022
Doc/library/socket.rst
Outdated
Comment on lines
829
to
830
| This is the base class for a type object of socket objects, and | ||
| ``isinstance(socket(...), SocketType)`` returns ``True``. |
There was a problem hiding this comment.
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``. |
There was a problem hiding this comment.
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.
Doc/library/socket.rst
Outdated
| ``isinstance(socket(...), SocketType)`` returns ``True``. | ||
|
|
||
| .. versionchanged:: 3.0 | ||
| SocketType is now the base class for the socket object type. |
There was a problem hiding this comment.
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. |
serhiy-storchaka
added
needs backport to 3.12
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the previous commit, SocketType was changed to the base class for the socket object type.
The purpose of this PR is to align the documentation with the above modifications.