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

79042ac4 · Tal Einat · GitHub · 59ad110d · 79042ac4
Commit 79042ac4 authored Jul 11, 2019 by Tal Einat Committed by GitHub Jul 11, 2019
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 3 deletions

Doc/library/select.rst Doc/library/select.rst +4 -3

No files found.
--- 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