[issue27088] doc: select: epoll.poll: incorrect timeout units, missing maxevents

[Berker Peksag]

Berker Peksag <berker.peksag at gmail.com> added the comment:

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 (https://github.com/python/cpython/pull/4798/files#r174309761), 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.

----------
nosy: +berker.peksag
resolution:  -> duplicate
stage:  -> resolved
status: open -> closed
superseder:  -> Document return value of epoll.poll
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue27088>
_______________________________________