[Python-checkins] bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)
Tal Einat
webhook-mailer at python.org
Thu Jul 11 10:17:12 EDT 2019
https://github.com/python/cpython/commit/46c2eff5adca7dc309f077ec65faf95b95c47b43
commit: 46c2eff5adca7dc309f077ec65faf95b95c47b43
branch: 2.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Tal Einat <taleinat at gmail.com>
date: 2019-07-11T17:17:08+03: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 7a080457a05e..b68b32486ad8 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:
More information about the Python-checkins
mailing list