traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve wording

This commit is contained in:
Andrew M. Kuchling 2008-09-24 17:27:55 +00:00
parent 1379ae02e3
commit 8798c90df2
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Doc/library/socket.rst
View File

@ -219,18 +219,18 @@ The module :mod:`socket` exports the following constants and functions:
.. function:: getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]]) .. function:: getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
Resolves the *host*/*port* argument, into a sequence of 5-tuples that contain Resolves the *host*/*port* argument, into a sequence of 5-tuples that contain
all the necessary argument for the sockets manipulation. *host* is a domain all the necessary arguments for creating the corresponding socket. *host* is a domain
name, a string representation of IPv4/v6 address or ``None``. *port* is a string name, a string representation of an IPv4/v6 address or ``None``. *port* is a string
service name (like ``'http'``), a numeric port number or ``None``. service name such as ``'http'``, a numeric port number or ``None``.
The rest of the arguments are optional and must be numeric if specified.
By passing ``None`` as the value of *host* and *port*, , you can pass ``NULL`` to the C API.
The rest of the arguments are optional and must be numeric if specified. For
*host* and *port*, by passing ``None``, you can pass ``NULL`` to the C API.
The :func:`getaddrinfo` function returns a list of 5-tuples with the following The :func:`getaddrinfo` function returns a list of 5-tuples with the following
structure: structure:
``(family, socktype, proto, canonname, sockaddr)`` ``(family, socktype, proto, canonname, sockaddr)``
*family*, *socktype*, *proto* are all integer and are meant to be passed to the *family*, *socktype*, *proto* are all integers and are meant to be passed to the
:func:`socket` function. *canonname* is a string representing the canonical name :func:`socket` function. *canonname* is a string representing the canonical name
of the *host*. It can be a numeric IPv4/v6 address when :const:`AI_CANONNAME` is of the *host*. It can be a numeric IPv4/v6 address when :const:`AI_CANONNAME` is
specified for a numeric *host*. *sockaddr* is a tuple describing a socket specified for a numeric *host*. *sockaddr* is a tuple describing a socket
@ -244,7 +244,7 @@ The module :mod:`socket` exports the following constants and functions:
Return a fully qualified domain name for *name*. If *name* is omitted or empty, Return a fully qualified domain name for *name*. If *name* is omitted or empty,
it is interpreted as the local host. To find the fully qualified name, the it is interpreted as the local host. To find the fully qualified name, the
hostname returned by :func:`gethostbyaddr` is checked, then aliases for the hostname returned by :func:`gethostbyaddr` is checked, followed by aliases for the
host, if available. The first name which includes a period is selected. In host, if available. The first name which includes a period is selected. In
case no fully qualified domain name is available, the hostname as returned by case no fully qualified domain name is available, the hostname as returned by
:func:`gethostname` is returned. :func:`gethostname` is returned.