summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTal Einat <taleinat@gmail.com>2019-07-11 17:00:34 +0300
committerGitHub <noreply@github.com>2019-07-11 17:00:34 +0300
commit79042ac4348ccc09344014f20dd49401579f8795 (patch)
treea8fa9abcee14b8f32742ff2624e6e446da0ec8af
parent59ad110d7a7784d53d0b502eebce0346597a6bef (diff)
downloadcpython-git-79042ac4348ccc09344014f20dd49401579f8795.tar.gz
bpo-34369: make kqueue.control() docs better reflect that timeout is positional-only (GH-9499)
-rw-r--r--Doc/library/select.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/select.rst b/Doc/library/select.rst
index 733a91e20b..8f5a2cea92 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