]> granicus.if.org Git - python/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:03 +0000 (07:16 -0700)
committerGitHub <noreply@github.com>
Thu, 11 Jul 2019 14:16:03 +0000 (07:16 -0700)
(cherry picked from commit 79042ac4348ccc09344014f20dd49401579f8795)

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

index 733a91e20b684d33cbde7fd9a81a37aafb295b7a..8f5a2cea9257cc2354eb55ed98cebfaaf121a1bd 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