mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

#16666: document default values for socket.getaddrinfo in the text to clarify that it doesn't accept keyword args.

Browse source
This commit is contained in:
Ezio Melotti 2012-12-25 14:45:55 +02:00
parent 94704fc25b
commit 513e9b4f61
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/socket.rst
View file

@ -230,7 +230,7 @@ The module :mod:`socket` exports the following constants and functions:
*source_address* was added. *source_address* was added.
.. function:: getaddrinfo(host, port, family=0, socktype=0, proto=0, flags=0) .. function:: getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
Translate the *host*/*port* argument into a sequence of 5-tuples that contain Translate the *host*/*port* argument into a sequence of 5-tuples that contain
all the necessary arguments for creating a socket connected to that service. all the necessary arguments for creating a socket connected to that service.
@ -240,12 +240,12 @@ The module :mod:`socket` exports the following constants and functions:
and *port*, you can pass ``NULL`` to the underlying C API. and *port*, you can pass ``NULL`` to the underlying C API.
The *family*, *socktype* and *proto* arguments can be optionally specified The *family*, *socktype* and *proto* arguments can be optionally specified
in order to narrow the list of addresses returned. Passing zero as a in order to narrow the list of addresses returned. By default, their value
value for each of these arguments selects the full range of results. is ``0``, meaning that the full range of results is selected.
The *flags* argument can be one or several of the ``AI_*`` constants, The *flags* argument can be one or several of the ``AI_*`` constants,
and will influence how results are computed and returned. and will influence how results are computed and returned. Its default value
For example, :const:`AI_NUMERICHOST` will disable domain name resolution is ``0``. For example, :const:`AI_NUMERICHOST` will disable domain name
and will raise an error if *host* is a domain name. resolution and will raise an error if *host* is a domain name.
The function returns a list of 5-tuples with the following structure: The function returns a list of 5-tuples with the following structure: