diff --git a/Doc/ACKS.txt b/Doc/ACKS.txt index 271ece9d229..4f7e833e2a7 100644 --- a/Doc/ACKS.txt +++ b/Doc/ACKS.txt @@ -79,6 +79,7 @@ docs@python.org), and we'll be glad to correct the problem. * Travis B. Hartwell * Tim Hatch * Janko Hauser + * Ben Hayden * Thomas Heller * Bernhard Herzog * Magnus L. Hetland diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index 14cd4ff5ce6..d462bb77480 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -513,14 +513,14 @@ The module :mod:`socket` exports the following constants and functions: .. function:: getdefaulttimeout() - Return the default timeout in floating seconds for new socket objects. A value + Return the default timeout in seconds (float) for new socket objects. A value of ``None`` indicates that new socket objects have no timeout. When the socket module is first imported, the default is ``None``. .. function:: setdefaulttimeout(timeout) - Set the default timeout in floating seconds for new socket objects. When + Set the default timeout in seconds (float) for new socket objects. When the socket module is first imported, the default is ``None``. See :meth:`~socket.settimeout` for possible values and their respective meanings. @@ -632,7 +632,7 @@ correspond to Unix system calls applicable to sockets. .. method:: socket.gettimeout() - Return the timeout in floating seconds associated with socket operations, + Return the timeout in seconds (float) associated with socket operations, or ``None`` if no timeout is set. This reflects the last call to :meth:`setblocking` or :meth:`settimeout`. diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c index bc11b23c567..fcdbf8afe1e 100644 --- a/Modules/socketmodule.c +++ b/Modules/socketmodule.c @@ -1808,7 +1808,7 @@ sock_gettimeout(PySocketSockObject *s) PyDoc_STRVAR(gettimeout_doc, "gettimeout() -> timeout\n\ \n\ -Returns the timeout in floating seconds associated with socket \n\ +Returns the timeout in seconds (float) associated with socket \n\ operations. A timeout of None indicates that timeouts on socket \n\ operations are disabled."); @@ -4201,7 +4201,7 @@ socket_getdefaulttimeout(PyObject *self) PyDoc_STRVAR(getdefaulttimeout_doc, "getdefaulttimeout() -> timeout\n\ \n\ -Returns the default timeout in floating seconds for new socket objects.\n\ +Returns the default timeout in seconds (float) for new socket objects.\n\ A value of None indicates that new socket objects have no timeout.\n\ When the socket module is first imported, the default is None."); @@ -4231,7 +4231,7 @@ socket_setdefaulttimeout(PyObject *self, PyObject *arg) PyDoc_STRVAR(setdefaulttimeout_doc, "setdefaulttimeout(timeout)\n\ \n\ -Set the default timeout in floating seconds for new socket objects.\n\ +Set the default timeout in seconds (float) for new socket objects.\n\ A value of None indicates that new socket objects have no timeout.\n\ When the socket module is first imported, the default is None.");