classification
Title: Document return value of epoll.poll
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Winterflower, berker.peksag, cheryl.sabella, docs@python, marco.buttu, njs
Priority: normal Keywords: patch

Created on 2017-01-12 04:23 by njs, last changed 2017-12-11 18:25 by berker.peksag.

Files
File name Uploaded Description Edit
issue29247.diff berker.peksag, 2017-01-30 10:45 review
Pull Requests
URL Status Linked Edit
PR 4798 open berker.peksag, 2017-12-11 18:24
Messages (4)
msg285285 - (view) Author: Nathaniel Smith (njs) * (Python committer) Date: 2017-01-12 04:23
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
msg286482 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2017-01-30 10:45
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!
msg286487 - (view) Author: Marco Buttu (marco.buttu) * Date: 2017-01-30 11:55
The patch LGTM. There is just one typo, I think (see review).
msg307847 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2017-12-08 12:42
Hi Berker,

Are you interested in making a pull request for this patch?  Thanks!
History
Date User Action Args
2018-08-19 12:08:26berker.peksaglinkissue27088 superseder
2017-12-11 18:25:22berker.peksagsetversions: - Python 2.7, Python 3.5
2017-12-11 18:24:56berker.peksagsetpull_requests: + pull_request4697
2017-12-08 12:42:23cheryl.sabellasetnosy: + cheryl.sabella
messages: + msg307847
2017-02-17 23:21:10Winterflowersetnosy: + Winterflower
2017-01-30 11:55:50marco.buttusetnosy: + marco.buttu
messages: + msg286487
2017-01-30 10:45:14berker.peksagsetfiles: + issue29247.diff

type: enhancement

keywords: + patch
nosy: + berker.peksag
messages: + msg286482
stage: patch review
2017-01-12 04:23:54njscreate