[issue29247] Document return value of epoll.poll
New submission from Nathaniel Smith:
The documentation for select.epoll.poll doesn't document the return value at all, which is somewhat important information :-)
I think it's a list of (fd, eventmask) tuples?
https://docs.python.org/3.7/library/select.html#select.epoll.poll
----------
assignee: docs@python
components: Documentation
messages: 285285
nosy: docs@python, njs
priority: normal
severity: normal
status: open
title: Document return value of epoll.poll
versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7
_______________________________________
Python tracker
Berker Peksag added the comment:
Thanks for the report, Nathaniel. I agree that the documentation could be improved. Here is a patch. I also moved the constant table to epoll.register() documentation (it's already done in https://docs.python.org/3.7/library/select.html#polling-objects)
It would be great if you could review the patch, thanks!
----------
keywords: +patch
nosy: +berker.peksag
stage: -> patch review
type: -> enhancement
Added file: http://bugs.python.org/file46454/issue29247.diff
_______________________________________
Python tracker
Marco Buttu added the comment:
The patch LGTM. There is just one typo, I think (see review).
----------
nosy: +marco.buttu
_______________________________________
Python tracker
Changes by Camilla Montonen
Cheryl Sabella
Change by Berker Peksag
Change by Berker Peksag
participants (5)
-
Berker Peksag
-
Camilla Montonen
-
Cheryl Sabella
-
Marco Buttu
-
Nathaniel Smith