djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Paul Sokolovsky 2017-11-23 18:03:32 +02:00
parent ec1e9a10a7
commit 067bf849d2
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/library/uselect.rst
View File

@ -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