bpo-41857: Document timeout arguments in select module#22406
Uh oh!
There was an error while loading. Please reload this page.
Conversation
zaneb commented Sep 25, 2020
This is just a docs change so I believe it should be given the "skip news" label. |
There was a problem hiding this comment.
Thanks @zaneb, this would certainly be an improvement!
A small request: I suggest more closely imitating the wording used by select.kqueue.control():
timeout as otimeout: object = None The maximum time to wait in seconds, or else None to wait forever. This accepts floats for smaller timeouts, too. 
bedevere-bot commented Sep 26, 2020
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
zanebforce-pushed the select-poll-timeout-docstrings branch from d54b73e to c4942e2Comparezaneb commented Oct 1, 2020
Thanks for the suggestion. I have made the requested changes; please review again. |
bedevere-bot commented Oct 1, 2020
Thanks for making the requested changes! @taleinat: please review the changes made to this pull request. |
zanebforce-pushed the select-poll-timeout-docstrings branch from c4942e2 to 891cd82CompareThe docstring for the poll() methods of the select.poll[1] and select.devpoll[2] classes did not describe the expected units of the timeout argument (milliseconds). Previously this information was only available from the online documentation. This is a potential source of confusion, because other poll() methods in the select module, such as select.epoll and select.kqueue objects, use units of seconds (and were documented). Include the units in the docstring description so that this information is at least available from interactive help. [1] https://docs.python.org/3/library/select.html#select.poll.poll [2] https://docs.python.org/3/library/select.html#select.devpoll.poll
zanebforce-pushed the select-poll-timeout-docstrings branch from 891cd82 to 6f86628Compare
Signed-off-by: Tal Einat <532281+taleinat@users.noreply.github.com>
taleinatforce-pushed the select-poll-timeout-docstrings branch from b48cc99 to adff1f0Compare
miss-islington commented Jan 20, 2022
miss-islington commented Jan 20, 2022
Sorry, @zaneb and @taleinat, I could not cleanly backport this to |
miss-islington commented Jan 20, 2022
Sorry @zaneb and @taleinat, I had trouble checking out the |
… select.depoll() doc-strings (pythonGH-22406). (cherry picked from commit 27df756) Co-authored-by: Zane Bitter <zbitter@redhat.com>
…select.depoll() doc-strings (pythonGH-22406). (cherry picked from commit 27df756) Co-authored-by: Zane Bitter <zbitter@redhat.com>
bedevere-bot commented Jan 21, 2022
GH-30741 is a backport of this pull request to the 3.10 branch. |
bedevere-bot commented Jan 21, 2022
GH-30742 is a backport of this pull request to the 3.9 branch. |
…select.depoll() doc-strings (pythonGH-22406) (cherry picked from commit 27df756) Co-authored-by: Zane Bitter <zbitter@redhat.com>
5 participants
The docstring for the poll() methods of the select.poll and
select.devpoll classes did not describe the expected units of the
timeout argument (milliseconds). Previously this information was only
available from the online documentation.
This is a potential source of confusion, because other poll() methods in
the select module, such as epoll and kqueue Polling objects, use units
of seconds (and were documented).
Include the units in the docstring description so that this information
is at least available from interactive help.
https://bugs.python.org/issue41857