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

docs: select: Describe extra details.

Browse Source
This commit is contained in:
Paul Sokolovsky 2014-11-08 20:14:05 +02:00
parent b98c162c52
commit d8474d3617
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/library/select.rst
View File

@ -1,10 +1,11 @@
:mod:`select` -- Provides select function to wait for events on a stream
:mod:`select` -- wait for events on a set of streams
========================================================================
.. module:: select
:synopsis: Provides select function to wait for events on a stream
:synopsis: wait for events on a set of streams
This module provides the select function.
This module provides functions to wait for events on streams (select streams
which are ready for operations).
Pyboard specifics
-----------------
@ -24,6 +25,9 @@ Functions
Wait for activity on a set of objects.
This function is provided for compatibility and is not efficient. Usage
of :class:`Poll` is recommended instead.
.. _class: Poll
class ``Poll``
@ -47,6 +51,7 @@ Methods
.. method:: poll.poll([timeout])
Wait for one of the registered objects to become ready.
Wait for at least one of the registered objects to become ready. Returns
list of ready objects, or empty list on timeout.
Timeout is in milliseconds.