diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-11-08 20:14:05 +0200 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-11-09 01:48:05 +0200 |
| commit | d8474d3617c621abf78b06419808d455b6b1ae27 (patch) | |
| tree | e17268fdafbde865e49b4c6c64e2e14c8710b8f8 /docs/library/select.rst | |
| parent | b98c162c522852d93ab55b64aae21188baba7f5a (diff) | |
| download | micropython-d8474d3617c621abf78b06419808d455b6b1ae27.tar.gz micropython-d8474d3617c621abf78b06419808d455b6b1ae27.zip | |
docs: select: Describe extra details.
Diffstat (limited to 'docs/library/select.rst')
| -rw-r--r-- | docs/library/select.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/library/select.rst b/docs/library/select.rst index 22e4c2097b..8713803de6 100644 --- a/docs/library/select.rst +++ b/docs/library/select.rst @@ -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. |