Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-45772: socket.socket should be a class instead of a function #23960

Merged
merged 2 commits into from
Nov 13, 2021

Conversation

xuhdev
Copy link
Contributor

@xuhdev xuhdev commented Dec 27, 2020

Currently socket.socket is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate socket.socket as a type.

https://bugs.python.org/issue45772

@github-actions
Copy link

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

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Jan 27, 2021
@xuhdev
Copy link
Contributor Author

xuhdev commented Jan 27, 2021

Could someone review this, please? This should be quite quick to review.

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Jan 28, 2021
@github-actions
Copy link

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

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Feb 28, 2021
@marsfan
Copy link

marsfan commented Nov 9, 2021

I have been running into this same issue. It would be really nice to see this fixed.

@arhadthedev
Copy link
Member

I created an entry for this pull request on bugs.python.org because most of people are there.

Actually, that's the very reason why authors should do it by themselves.

@arhadthedev
Copy link
Member

arhadthedev commented Nov 9, 2021

In addition, status checks in the bottom of this GitHub page state the following:

  • bedevere/issue-number — No issue # in title or "skip issue" label found
  • bedevere/news — No news entry in Misc/NEWS.d/next/ or "skip news" label found

So you need to change a title of this issue to
image
(because that number was assigned to the entry I've created). Then you can look among already merged PR requests to see how other add to NEWS.d.

Edit: the bot replaced [bpo-...] with \[[bpo\](...), so I changed this part of a text with a screenshot.

@xuhdev xuhdev changed the title socket.socket should be a class instead of a function [bpo-45772] socket.socket should be a class instead of a function Nov 9, 2021
Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
@xuhdev xuhdev changed the title [bpo-45772] socket.socket should be a class instead of a function bpo-45772: socket.socket should be a class instead of a function Nov 9, 2021
@xuhdev
Copy link
Contributor Author

xuhdev commented Nov 9, 2021

Thanks @arhadthedev , I've updated the PR.

@terryjreedy
Copy link
Member

@marsfan add your supporting comment on the issue, with explanation if possible.

@asvetlov asvetlov added needs backport to 3.8 only security fixes needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Nov 13, 2021
@asvetlov asvetlov merged commit 4c792f3 into python:main Nov 13, 2021
@miss-islington
Copy link
Contributor

Thanks @xuhdev for the PR, and @asvetlov for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9, 3.10.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-29542 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Nov 13, 2021
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 13, 2021
…honGH-23960)

* bpo-45772: socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f3)

Co-authored-by: Hong Xu <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 13, 2021
…honGH-23960)

* bpo-45772: socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f3)

Co-authored-by: Hong Xu <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.9 only security fixes label Nov 13, 2021
@bedevere-bot
Copy link

GH-29543 is a backport of this pull request to the 3.9 branch.

@bedevere-bot
Copy link

GH-29544 is a backport of this pull request to the 3.8 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.8 only security fixes label Nov 13, 2021
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 13, 2021
…honGH-23960)

* bpo-45772: socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f3)

Co-authored-by: Hong Xu <[email protected]>
miss-islington added a commit that referenced this pull request Nov 13, 2021
…on (GH-23960) (GH-29542)

* [bpo-45772](): socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f3)


Co-authored-by: Hong Xu <[email protected]>

Automerge-Triggered-By: GH:asvetlov
miss-islington added a commit that referenced this pull request Nov 13, 2021
GH-23960) (GH-29543)

* [bpo-45772](): socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
(cherry picked from commit 4c792f3)


Co-authored-by: Hong Xu <[email protected]>

Automerge-Triggered-By: GH:asvetlov
remykarem pushed a commit to remykarem/cpython that referenced this pull request Dec 7, 2021
…honGH-23960)

* bpo-45772: socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
remykarem pushed a commit to remykarem/cpython that referenced this pull request Jan 30, 2022
…honGH-23960)

* bpo-45772: socket.socket should be a class instead of a function

Currently `socket.socket` is documented as a function, but it is really
a class (and thus has function-like usage to construct an object). This
correction would ensure that Python projects that are interlinking
Python's documentation can properly locate `socket.socket` as a type.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir stale Stale PR or inactive for long period of time.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants