]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] Document None for timeout argument of select.select (GH-142177)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 2 Dec 2025 13:32:04 +0000 (14:32 +0100)
committerGitHub <noreply@github.com>
Tue, 2 Dec 2025 13:32:04 +0000 (14:32 +0100)
cherry picked from commit 82274c491a48c8cebbc1a1350a9cc67bb423caff (GH-142182)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Doc/library/select.rst

index bbac9bc4bbe3ee4ac26dd5402e05a27510e7e429..2e3db8ebb324b598b1c6aff61f4880fc74b43a2c 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
@@ -130,7 +130,8 @@ The module defines the following:
    Empty iterables are allowed, but acceptance of three empty iterables is
    platform-dependent. (It is known to work on Unix but not on Windows.)  The
    optional *timeout* argument specifies a time-out as a floating-point number
-   in seconds.  When the *timeout* argument is omitted the function blocks until
+   in seconds.
+   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.