This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: doc: select: epoll.poll: incorrect timeout units, missing maxevents
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.6, Python 2.7
Status: closed Resolution: duplicate
Dependencies: Superseder: Document return value of epoll.poll
View: 29247
Assigned To: docs@python Nosy List: berker.peksag, docs@python, fordsfords
Priority: normal Keywords:

Created on 2016-05-22 23:39 by fordsfords, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (2)
msg266118 - (view) Author: Steve Ford (fordsfords) Date: 2016-05-22 23:39
The short description of epoll.poll is correct (gives timeout unit as seconds [float]; includes maxevents).  However, the long description lists the timeout units as milliseconds ("If timeout is given, it specifies the length of time in milliseconds which the system will wait for events before returning."), and does not include maxevents at all.


See also
msg323753 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2018-08-19 12:08
Thanks for the report. In the title, you mentioned epoll.poll(), but you gave the link to the poll.poll() documentation. Also, the part you quoted

    If timeout is given, it specifies the length of time in milliseconds
    which the system will wait for events before returning.

is from the poll.poll() documentation.

Currently, the documentation for epoll.poll() is pretty minimal:

    epoll.poll(timeout=-1, maxevents=-1)
    Wait for events. timeout in seconds (float)

There is an open issue to improve epoll.poll() documentation: Issue 29247. Also, there is a review comment about explaining the *maxevent* parameter (, so I'm going to address the issues you've mentioned in msg266118 as part of issue 29247.

In the meantime, I'm closing this as a duplicate of issue 29247.
Date User Action Args
2022-04-11 14:58:31adminsetgithub: 71275
2018-08-19 12:08:26berker.peksagsetstatus: open -> closed

superseder: Document return value of epoll.poll
type: behavior

nosy: + berker.peksag
messages: + msg323753
resolution: duplicate
stage: resolved
2016-05-22 23:39:31fordsfordscreate