[Python-checkins] bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)

Miss Islington (bot) webhook-mailer at python.org
Thu Jul 11 10:16:10 EDT 2019


https://github.com/python/cpython/commit/dc0b6af42eca70e520b67d0bcf4dc5278a3f02dd
commit: dc0b6af42eca70e520b67d0bcf4dc5278a3f02dd
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-07-11T07:16:03-07:00
summary:

bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)

(cherry picked from commit 79042ac4348ccc09344014f20dd49401579f8795)

Co-authored-by: Tal Einat <taleinat at gmail.com>

files:
M Doc/library/select.rst

diff --git a/Doc/library/select.rst b/Doc/library/select.rst
index 733a91e20b68..8f5a2cea9257 100644
--- a/Doc/library/select.rst
+++ b/Doc/library/select.rst
@@ -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



More information about the Python-checkins mailing list