summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2008-09-24 17:27:55 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2008-09-24 17:27:55 (GMT)
commit8798c90df2b2d77ddb76611c0ea4be463c543f2b (patch)
treeb6e5ed0f61103ba99322b8c1d913cf4b08b284ae
parent1379ae02e3c893c01f9a97dc3baa12c9a54a1cab (diff)
downloadcpython-8798c90df2b2d77ddb76611c0ea4be463c543f2b.zip
cpython-8798c90df2b2d77ddb76611c0ea4be463c543f2b.tar.gz
cpython-8798c90df2b2d77ddb76611c0ea4be463c543f2b.tar.bz2
Improve wording
-rw-r--r--Doc/library/socket.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 16feee5..1ee2875 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -219,18 +219,18 @@ The module :mod:`socket` exports the following constants and functions:
.. function:: getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
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
- name, a string representation of IPv4/v6 address or ``None``. *port* is a string
- service name (like ``'http'``), a numeric port number or ``None``.
+ all the necessary arguments for creating the corresponding socket. *host* is a domain
+ name, a string representation of an IPv4/v6 address or ``None``. *port* is a string
+ 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
structure:
``(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
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
@@ -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,
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
case no fully qualified domain name is available, the hostname as returned by
:func:`gethostname` is returned.