summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-07-11 14:16:03 (GMT)
committerGitHub <noreply@github.com>2019-07-11 14:16:03 (GMT)
commitdc0b6af42eca70e520b67d0bcf4dc5278a3f02dd (patch)
tree469e55f6df044415a1b872198aef6dfbbc462fa2
parentaca82977632fafa1d97c938999d76fae37c64f23 (diff)
downloadcpython-dc0b6af42eca70e520b67d0bcf4dc5278a3f02dd.zip
cpython-dc0b6af42eca70e520b67d0bcf4dc5278a3f02dd.tar.gz
cpython-dc0b6af42eca70e520b67d0bcf4dc5278a3f02dd.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>
-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 733a91e..8f5a2ce 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