Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
ghost commentedMay 27, 2022 • edited by ghost
Loading Uh oh!
There was an error while loading.Please reload this page.
edited by ghost
Uh oh!
There was an error while loading.Please reload this page.
All commit authors signed the Contributor License Agreement. |
bedevere-bot commentedMay 27, 2022
Most changes to Pythonrequire a NEWS entry. Please add it using theblurb_it web app or theblurb command-line tool. |
You don't need NEWS, please delete it. A |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Two wording suggestions.
A
Doc/library/socket.rst Outdated
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| This is the base class fora type object ofsocket 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.
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 objectsocket.socket. Consider that elsewhere in this documentsocket object refers to an instance of the type objectsocket.socket. Wouldn't it be less precise if we just said thatSocketType is the base class ofsocket 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| SocketType isnowthe base class forthesocketobject type. | |
| SocketType is the base class for socketobjects | |
| rather than being ``type(socket(...))``` directly. |
Uh oh!
There was an error while loading.Please reload this page.
In theprevious 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.