Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)

This commit is contained in:
Zane Bitter 2022-01-20 18:08:44 -05:00 committed by GitHub
parent 9e87c0e03f
commit 27df7566bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Modules/clinic/selectmodule.c.h generated
View File

@ -193,6 +193,10 @@ PyDoc_STRVAR(select_poll_poll__doc__,
"\n" "\n"
"Polls the set of registered file descriptors.\n" "Polls the set of registered file descriptors.\n"
"\n" "\n"
" timeout\n"
" The maximum time to wait in milliseconds, or else None (or a negative\n"
" value) to wait indefinitely.\n"
"\n"
"Returns a list containing any descriptors that have events or errors to\n" "Returns a list containing any descriptors that have events or errors to\n"
"report, as a list of (fd, event) 2-tuples."); "report, as a list of (fd, event) 2-tuples.");
@ -363,6 +367,10 @@ PyDoc_STRVAR(select_devpoll_poll__doc__,
"\n" "\n"
"Polls the set of registered file descriptors.\n" "Polls the set of registered file descriptors.\n"
"\n" "\n"
" timeout\n"
" The maximum time to wait in milliseconds, or else None (or a negative\n"
" value) to wait indefinitely.\n"
"\n"
"Returns a list containing any descriptors that have events or errors to\n" "Returns a list containing any descriptors that have events or errors to\n"
"report, as a list of (fd, event) 2-tuples."); "report, as a list of (fd, event) 2-tuples.");
@ -1181,4 +1189,4 @@ exit:
#ifndef SELECT_KQUEUE_CONTROL_METHODDEF #ifndef SELECT_KQUEUE_CONTROL_METHODDEF
#define SELECT_KQUEUE_CONTROL_METHODDEF #define SELECT_KQUEUE_CONTROL_METHODDEF
#endif /* !defined(SELECT_KQUEUE_CONTROL_METHODDEF) */ #endif /* !defined(SELECT_KQUEUE_CONTROL_METHODDEF) */
/*[clinic end generated code: output=ed1e5a658863244c input=a9049054013a1b77]*/ /*[clinic end generated code: output=09ff9484c1b092fb input=a9049054013a1b77]*/

8
Modules/selectmodule.c
View File

@ -570,6 +570,8 @@ select_poll_unregister_impl(pollObject *self, int fd)
select.poll.poll select.poll.poll
timeout as timeout_obj: object = None timeout as timeout_obj: object = None
The maximum time to wait in milliseconds, or else None (or a negative
value) to wait indefinitely.
/ /
Polls the set of registered file descriptors. Polls the set of registered file descriptors.
@ -580,7 +582,7 @@ report, as a list of (fd, event) 2-tuples.
static PyObject * static PyObject *
select_poll_poll_impl(pollObject *self, PyObject *timeout_obj) select_poll_poll_impl(pollObject *self, PyObject *timeout_obj)
/*[clinic end generated code: output=876e837d193ed7e4 input=7a446ed45189e894]*/ /*[clinic end generated code: output=876e837d193ed7e4 input=c2f6953ec45e5622]*/
{ {
PyObject *result_list = NULL; PyObject *result_list = NULL;
int poll_result, i, j; int poll_result, i, j;
@ -894,6 +896,8 @@ select_devpoll_unregister_impl(devpollObject *self, int fd)
/*[clinic input] /*[clinic input]
select.devpoll.poll select.devpoll.poll
timeout as timeout_obj: object = None timeout as timeout_obj: object = None
The maximum time to wait in milliseconds, or else None (or a negative
value) to wait indefinitely.
/ /
Polls the set of registered file descriptors. Polls the set of registered file descriptors.
@ -904,7 +908,7 @@ report, as a list of (fd, event) 2-tuples.
static PyObject * static PyObject *
select_devpoll_poll_impl(devpollObject *self, PyObject *timeout_obj) select_devpoll_poll_impl(devpollObject *self, PyObject *timeout_obj)
/*[clinic end generated code: output=2654e5457cca0b3c input=fd0db698d84f0333]*/ /*[clinic end generated code: output=2654e5457cca0b3c input=3c3f0a355ec2bedb]*/
{ {
struct dvpoll dvp; struct dvpoll dvp;
PyObject *result_list = NULL; PyObject *result_list = NULL;