From 27df7566bc19699b967e0e30d7808637b90141f6 Mon Sep 17 00:00:00 2001 From: Zane Bitter Date: Thu, 20 Jan 2022 18:08:44 -0500 Subject: [PATCH] bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406) --- Modules/clinic/selectmodule.c.h | 10 +++++++++- Modules/selectmodule.c | 8 ++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/Modules/clinic/selectmodule.c.h b/Modules/clinic/selectmodule.c.h index a1695f2390a..ca06dae3296 100644 --- a/Modules/clinic/selectmodule.c.h +++ b/Modules/clinic/selectmodule.c.h @@ -193,6 +193,10 @@ PyDoc_STRVAR(select_poll_poll__doc__, "\n" "Polls the set of registered file descriptors.\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" "report, as a list of (fd, event) 2-tuples."); @@ -363,6 +367,10 @@ PyDoc_STRVAR(select_devpoll_poll__doc__, "\n" "Polls the set of registered file descriptors.\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" "report, as a list of (fd, event) 2-tuples."); @@ -1181,4 +1189,4 @@ exit: #ifndef SELECT_KQUEUE_CONTROL_METHODDEF #define 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]*/ diff --git a/Modules/selectmodule.c b/Modules/selectmodule.c index 367e299f83a..1a5a63249c7 100644 --- a/Modules/selectmodule.c +++ b/Modules/selectmodule.c @@ -570,6 +570,8 @@ select_poll_unregister_impl(pollObject *self, int fd) select.poll.poll 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. @@ -580,7 +582,7 @@ report, as a list of (fd, event) 2-tuples. static PyObject * 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; int poll_result, i, j; @@ -894,6 +896,8 @@ select_devpoll_unregister_impl(devpollObject *self, int fd) /*[clinic input] select.devpoll.poll 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. @@ -904,7 +908,7 @@ report, as a list of (fd, event) 2-tuples. static PyObject * 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; PyObject *result_list = NULL;