]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 11 Jul 2019 14:16:45 +0000 (07:16 -0700)
committerTal Einat <taleinat@gmail.com>
Thu, 11 Jul 2019 14:16:45 +0000 (17:16 +0300)
(cherry picked from commit 79042ac4348ccc09344014f20dd49401579f8795)

Co-authored-by: Tal Einat <taleinat@gmail.com>
Doc/library/select.rst

index 5b8fd7ee805c5216c6ce6ff9046688144c878ac3..7d65363e493133222d24a705da3567307bc5e929 100644 (file)
@@ -480,13 +480,14 @@ Kqueue Objects
    Create a kqueue object from a given file descriptor.
 
 
-.. method:: kqueue.control(changelist, max_events[, timeout=None]) -> eventlist
+.. method:: kqueue.control(changelist, max_events[, timeout]) -> eventlist
 
    Low level interface to kevent
 
-   - changelist must be an iterable of kevent object or ``None``
+   - changelist must be an iterable of kevent objects or ``None``
    - max_events must be 0 or a positive integer
-   - timeout in seconds (floats possible)
+   - timeout in seconds (floats possible); the default is ``None``,
+     to wait forever
 
    .. versionchanged:: 3.5
       The function is now retried with a recomputed timeout when interrupted by