diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-07-11 14:17:08 (GMT) |
---|---|---|
committer | Tal Einat <taleinat@gmail.com> | 2019-07-11 14:17:08 (GMT) |
commit | 46c2eff5adca7dc309f077ec65faf95b95c47b43 (patch) | |
tree | 6791f453f9a7bf44e614f7b0892c39518f3f95ac /Doc | |
parent | 0517375c4494b728171b0e306959e3f2703e0046 (diff) | |
download | cpython-46c2eff5adca7dc309f077ec65faf95b95c47b43.zip cpython-46c2eff5adca7dc309f077ec65faf95b95c47b43.tar.gz cpython-46c2eff5adca7dc309f077ec65faf95b95c47b43.tar.bz2 |
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@gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/select.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/select.rst b/Doc/library/select.rst index 7a08045..b68b324 100644 --- a/Doc/library/select.rst +++ b/Doc/library/select.rst @@ -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: |