Skip to content

Commit dc0b6af

Browse files
bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)
(cherry picked from commit 79042ac) Co-authored-by: Tal Einat <[email protected]>
1 parent aca8297 commit dc0b6af

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Doc/library/select.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,13 +480,14 @@ Kqueue Objects
480480
Create a kqueue object from a given file descriptor.
481481

482482

483-
.. method:: kqueue.control(changelist, max_events[, timeout=None]) -> eventlist
483+
.. method:: kqueue.control(changelist, max_events[, timeout]) -> eventlist
484484

485485
Low level interface to kevent
486486

487-
- changelist must be an iterable of kevent object or ``None``
487+
- changelist must be an iterable of kevent objects or ``None``
488488
- max_events must be 0 or a positive integer
489-
- timeout in seconds (floats possible)
489+
- timeout in seconds (floats possible); the default is ``None``,
490+
to wait forever
490491

491492
.. versionchanged:: 3.5
492493
The function is now retried with a recomputed timeout when interrupted by

0 commit comments

Comments
 (0)