[3.9] bpo-45772: socket.socket should be a class instead of a function (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 4c792f39e6)


Co-authored-by: Hong Xu <hong@topbug.net>

Automerge-Triggered-By: GH:asvetlov
This commit is contained in:
Miss Islington (bot) 2021-11-12 22:29:01 -08:00 committed by GitHub
parent 587ff7f50b
commit b952f60213
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions

View file

@ -552,7 +552,7 @@ Creating sockets
The following functions all create :ref:`socket objects <socket-objects>`.
.. function:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
.. class:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
Create a new socket using the given address family, socket type and protocol
number. The address family should be :const:`AF_INET` (the default),

View file

@ -0,0 +1 @@
``socket.socket`` documentation is corrected to a class from a function.