diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-11-13 06:29:01 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-13 06:29:01 (GMT) |
| commit | b952f60213c60f89a50e4538783a18ced64ca91f (patch) | |
| tree | 284e03f8a1d5d48eb7071182b36c639808f7d77f | |
| parent | 587ff7f50bcbfd8346c6d5db459a1628a350c04d (diff) | |
| download | cpython-b952f60213c60f89a50e4538783a18ced64ca91f.zip cpython-b952f60213c60f89a50e4538783a18ced64ca91f.tar.gz cpython-b952f60213c60f89a50e4538783a18ced64ca91f.tar.bz2 | |
[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 4c792f39e688b11c7c19e411ed4f76a7baa44638)
Co-authored-by: Hong Xu <hong@topbug.net>
Automerge-Triggered-By: GH:asvetlov
| -rwxr-xr-x | Doc/library/socket.rst | 2 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index db94a2a..f0a1338 100755 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -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), diff --git a/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst b/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst new file mode 100644 index 0000000..4767952 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-11-09-13-10-55.bpo-45772.EdrM3t.rst @@ -0,0 +1 @@ +``socket.socket`` documentation is corrected to a class from a function. |