Skip to content

Commit caf1794

Browse files
[3.13] Document None for timeout argument of select.select (GH-142177)
cherry picked from commit 82274c4 (GH-142182) Co-authored-by: Petr Viktorin <encukou@gmail.com>
1 parent a62caed commit caf1794

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Doc/library/select.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The module defines the following:
115115
:ref:`kevent-objects` below for the methods supported by kevent objects.
116116

117117

118-
.. function:: select(rlist, wlist, xlist[, timeout])
118+
.. function:: select(rlist, wlist, xlist, timeout=None)
119119

120120
This is a straightforward interface to the Unix :c:func:`!select` system call.
121121
The first three arguments are iterables of 'waitable objects': either
@@ -130,7 +130,8 @@ The module defines the following:
130130
Empty iterables are allowed, but acceptance of three empty iterables is
131131
platform-dependent. (It is known to work on Unix but not on Windows.) The
132132
optional *timeout* argument specifies a time-out as a floating-point number
133-
in seconds. When the *timeout* argument is omitted the function blocks until
133+
in seconds.
134+
When the *timeout* argument is omitted or ``None``, the function blocks until
134135
at least one file descriptor is ready. A time-out value of zero specifies a
135136
poll and never blocks.
136137

0 commit comments

Comments
 (0)