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.

classification
Title: Document timeout arguments to poll() in select module
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, taleinat, zaneb
Priority: normal Keywords: patch

Created on 2020-09-25 02:00 by zaneb, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 22406 merged zaneb, 2020-09-25 02:09
PR 30741 merged taleinat, 2022-01-21 08:31
PR 30742 merged taleinat, 2022-01-21 08:40
Messages (5)
msg377473 - (view) Author: Zane Bitter (zaneb) * Date: 2020-09-25 02:00
The select.poll.poll() and select.devpoll.poll() methods don't have their timeout arguments documented in their docstrings. In both cases the argument is in milliseconds, whereas the timeout arguments to select.kqueue.control() and select.epoll.poll() are in seconds, and are documented in the docstring.
msg411053 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-20 23:08
New changeset 27df7566bc19699b967e0e30d7808637b90141f6 by Zane Bitter in branch 'main':
bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
https://github.com/python/cpython/commit/27df7566bc19699b967e0e30d7808637b90141f6
msg411099 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-21 09:02
New changeset f6e5972fa984c10d47694973db1c91c6486d654a by Tal Einat in branch '3.10':
[3.10] bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
https://github.com/python/cpython/commit/f6e5972fa984c10d47694973db1c91c6486d654a
msg411101 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-21 09:37
New changeset 656971e4953a70a6048170377888db5530eea0a6 by Tal Einat in branch '3.9':
[3.9] bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
https://github.com/python/cpython/commit/656971e4953a70a6048170377888db5530eea0a6
msg411102 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-21 09:38
Thanks for this improvement, Zane!
History
Date User Action Args
2022-04-11 14:59:36adminsetgithub: 86023
2022-01-21 09:38:43taleinatsetstatus: open -> closed
resolution: fixed
messages: + msg411102

stage: patch review -> resolved
2022-01-21 09:37:44taleinatsetmessages: + msg411101
2022-01-21 09:02:54taleinatsetmessages: + msg411099
2022-01-21 08:40:58taleinatsetpull_requests: + pull_request28929
2022-01-21 08:31:56taleinatsetpull_requests: + pull_request28928
2022-01-20 23:08:52taleinatsetnosy: + taleinat
messages: + msg411053
2022-01-20 22:28:01taleinatsetversions: + Python 3.9, Python 3.11
2020-09-25 02:09:38zanebsetkeywords: + patch
stage: patch review
pull_requests: + pull_request21446
2020-09-25 02:00:00zanebcreate