FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-71566: Fix SocketType introduction in the socket documentation. by xiaochen7 · Pull Request #93288 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

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

Closed
xiaochen7 wants to merge 6 commits into
python:mainfrom
xiaochen7:gh-71566
ConversationCommits (6)ChecksFiles changed
Closed

gh-71566: Fix SocketType introduction in the socket documentation.#93288
xiaochen7 wants to merge 6 commits into
python:mainfrom
xiaochen7:gh-71566

Conversation

xiaochen7 commented May 27, 2022 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

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.

ghost commented May 27, 2022 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

bedevere-bot commented May 27, 2022

Copy link
Copy Markdown

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 27, 2022
xiaochen7 mentioned this pull request May 27, 2022
Closed

AA-Turner commented May 27, 2022

Copy link
Copy Markdown
Member

You don't need NEWS, please delete it.

A

AA-Turner requested changes May 27, 2022
View reviewed changes

AA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Two wording suggestions.

A

Comment thread 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``.

AA-Turner May 27, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
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``.

xiaochen7 May 28, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Comment thread Doc/library/socket.rst Outdated
``isinstance(socket(...), SocketType)`` returns ``True``.

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

AA-Turner May 27, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
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 only security fixes needs backport to 3.13 only security fixes and removed needs backport to 3.10 needs backport to 3.11 only security fixes labels May 9, 2024
hugovk removed the needs backport to 3.12 only security fixes label Apr 10, 2025
serhiy-storchaka added the needs backport to 3.14 bugs and security fixes label May 8, 2025
StanFromIreland mentioned this pull request Dec 29, 2025
Closed
aisk reviewed Dec 30, 2025
View reviewed changes
Comment thread Doc/library/socket.rst

.. versionchanged:: 3.0
SocketType is the base class for the socket object type rather than
being ``type(socket(...))``` directly.

aisk Dec 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

There is a RST marker error:

Suggested change
being ``type(socket(...))``` directly.
being ``type(socket(...))`` directly.

github-actions Bot commented Apr 11, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Apr 11, 2026
serhiy-storchaka added the needs backport to 3.15 bugs and security fixes label May 30, 2026
gaborbernat mentioned this pull request May 31, 2026
Merged
github-actions Bot removed the stale Stale PR or inactive for long period of time. label Jun 5, 2026

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown

This PR is stale because it has been open for 90 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Sep 6, 2026

aisk commented Sep 6, 2026

Copy link
Copy Markdown
Member

Already fixed in #150683

aisk closed this Sep 6, 2026
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

aisk aisk left review comments
AA-Turner AA-Turner requested changes

Assignees

No one assigned

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes skip news stale Stale PR or inactive for long period of time.

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

Back | FazBrowse Home | New Git URL