Skip to content
Snippets Groups Projects
Commit 067bf849 authored by Paul Sokolovsky's avatar Paul Sokolovsky
Browse files

docs/uselect: poll: Explicitly specify that no-timeout value is -1.

parent ec1e9a10
No related branches found
No related tags found
No related merge requests found
...@@ -50,10 +50,11 @@ Methods ...@@ -50,10 +50,11 @@ Methods
Modify the *eventmask* for *obj*. 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 Wait for at least one of the registered objects to become ready, with optional
list of (``obj``, ``event``, ...) tuples, ``event`` element specifies 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*`` which events happened with a stream and is a combination of ``select.POLL*``
constants described above. There may be other elements in tuple, depending 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 on a platform and version, so don't assume that its size is 2. In case of
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment