diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-11-23 18:03:32 +0200 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-11-23 18:03:32 +0200 |
| commit | 067bf849d29ab46319740a10561a112376415f51 (patch) | |
| tree | fe3b1f8fe2bd82c01db19fcd816909fb7669dd81 | |
| parent | ec1e9a10a73d9c5c3771a5797e9eceb62475b197 (diff) | |
docs/uselect: poll: Explicitly specify that no-timeout value is -1.
| -rw-r--r-- | docs/library/uselect.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/library/uselect.rst b/docs/library/uselect.rst index beffce69a..b9e5da999 100644 --- a/docs/library/uselect.rst +++ b/docs/library/uselect.rst @@ -50,10 +50,11 @@ Methods Modify the *eventmask* for *obj*. -.. method:: poll.poll([timeout]) +.. method:: poll.poll(timeout=-1) - Wait for at least one of the registered objects to become ready. Returns - list of (``obj``, ``event``, ...) tuples, ``event`` element specifies + Wait for at least one of the registered objects to become ready, with optional + timeout in milliseconds (if *timeout* arg is not specified or -1, there is no + timeout). Returns list of (``obj``, ``event``, ...) tuples, ``event`` element specifies which events happened with a stream and is a combination of ``select.POLL*`` constants described above. There may be other elements in tuple, depending on a platform and version, so don't assume that its size is 2. In case of |