Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2019
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b3f2d1
bpo-34369: make docs better reflect that timeout is positional-only
taleinat Sep 22, 2018
3c5460b
bpo-34369: describe default value and behavior of the timeout param
taleinat Sep 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Doc/library/select.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,13 +475,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
Expand Down