]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Document None for timeout argument of select.select (#142177)
authorPetr Viktorin <encukou@gmail.com>
Tue, 2 Dec 2025 08:57:09 +0000 (09:57 +0100)
committerGitHub <noreply@github.com>
Tue, 2 Dec 2025 08:57:09 +0000 (10:57 +0200)
Doc/library/select.rst

index e821cb01d941b2f552a701d27443eae416335888..62b5161fb8063492ceee282549f5913a87a69f66 100644 (file)
@@ -115,7 +115,7 @@ The module defines the following:
    :ref:`kevent-objects` below for the methods supported by kevent objects.
 
 
-.. function:: select(rlist, wlist, xlist[, timeout])
+.. function:: select(rlist, wlist, xlist, timeout=None)
 
    This is a straightforward interface to the Unix :c:func:`!select` system call.
    The first three arguments are iterables of 'waitable objects': either
@@ -131,7 +131,7 @@ The module defines the following:
    platform-dependent. (It is known to work on Unix but not on Windows.)  The
    optional *timeout* argument specifies a time-out in seconds; it may be
    a non-integer to specify fractions of seconds.
-   When the *timeout* argument is omitted the function blocks until
+   When the *timeout* argument is omitted or ``None``, the function blocks until
    at least one file descriptor is ready.  A time-out value of zero specifies a
    poll and never blocks.