mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-23 10:16:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Doc: Minor adjustment of socket.create_server docs (#26938)

Browse source 
- fix spelling in create_server() docs
- add a line about create_server() in the socket.py docstring
This commit is contained in:
Pavel 2022-05-20 04:18:02 -04:00 • committed by GitHub
parent 909868db2a
commit a637c09a60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/library/socket.rst
View file

@ -712,7 +712,7 @@ The following functions all create :ref:`socket objects <socket-objects>`.
.. function:: create_server(address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False) .. function:: create_server(address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)
Convenience function which creates a TCP socket bound to *address* (a 2-tuple Convenience function which creates a TCP socket bound to *address* (a 2-tuple
``(host, port)``) and return the socket object. ``(host, port)``) and returns the socket object.
*family* should be either :data:`AF_INET` or :data:`AF_INET6`. *family* should be either :data:`AF_INET` or :data:`AF_INET6`.
*backlog* is the queue size passed to :meth:`socket.listen`; when ``0`` *backlog* is the queue size passed to :meth:`socket.listen`; when ``0``

1
Lib/socket.py
View file

@ -28,6 +28,7 @@ socket.getdefaulttimeout() -- get the default timeout value
socket.setdefaulttimeout() -- set the default timeout value socket.setdefaulttimeout() -- set the default timeout value
create_connection() -- connects to an address, with an optional timeout and create_connection() -- connects to an address, with an optional timeout and
optional source address. optional source address.
create_server() -- create a TCP socket and bind it to a specified address.
[*] not available on all platforms! [*] not available on all platforms!