]> 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:17:08 +0000 (07:17 -0700)
committerTal Einat <taleinat@gmail.com>
Thu, 11 Jul 2019 14:17:08 +0000 (17:17 +0300)
(cherry picked from commit 79042ac4348ccc09344014f20dd49401579f8795)

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

index 7a080457a05e984e4cc7463652ad61b5beccca72..b68b32486ad8373dbaf07f1409dceb821c1b51ca 100644 (file)
@@ -291,13 +291,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
 
 
 .. _kevent-objects: