[3.9]bpo-41857: Document timeout arguments in select module (GH-22406) #30742
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…select.depoll() doc-strings (pythonGH-22406). (cherry picked from commit 27df756) Co-authored-by: Zane Bitter <zbitter@redhat.com>
taleinat
requested review from
1st1,
abalkin,
asvetlov,
berkerpeksag,
brettcannon,
cjw296,
encukou,
ericsnowcurrently,
ericvsmith,
ethanfurman,
ezio-melotti,
Fidget-Spinner,
gpshead,
gvanrossum,
iritkatriel,
isidentical,
lysnikolaou,
markshannon,
methane,
ncoghlan,
pablogsal,
pganssle,
rhettinger,
terryjreedy,
tiran,
vsajip,
warsaw and
a team
as code owners
taleinat
removed request for
gpshead,
vsajip,
methane,
warsaw,
1st1,
encukou,
asvetlov,
tiran,
ericvsmith,
abalkin,
cjw296,
ncoghlan,
iritkatriel,
ericsnowcurrently,
pganssle,
rhettinger,
gvanrossum,
ethanfurman,
markshannon,
pablogsal,
terryjreedy,
lysnikolaou,
ezio-melotti,
Fidget-Spinner and
isidentical
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Co-authored-by: Zane Bitter zbitter@redhat.com
https://bugs.python.org/issue41857