summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-10-29 22:08:10 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2015-10-29 22:08:10 +0300
commit98b6d35c4ffa8ad40fb7aead3b9025c5e0471c27 (patch)
tree184b5b91854c7c5be85f91bacc0519b9c0bbacf3
parent9b12bc788fd044ee6320c06287add1cf4bc5f0ed (diff)
downloadmicropython-98b6d35c4ffa8ad40fb7aead3b9025c5e0471c27.tar.gz
micropython-98b6d35c4ffa8ad40fb7aead3b9025c5e0471c27.zip
docs: select: Describe poll.poll() return value in detail.
-rw-r--r--docs/library/select.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/library/select.rst b/docs/library/select.rst
index 8713803de6..7c16b02e96 100644
--- a/docs/library/select.rst
+++ b/docs/library/select.rst
@@ -52,6 +52,10 @@ Methods
.. method:: poll.poll([timeout])
Wait for at least one of the registered objects to become ready. Returns
- list of ready objects, or empty list on timeout.
+ list of (``obj``, ``event``, ...) tuples, ``event`` element specifying
+ whether ``obj`` is ready for reading, writing, or both (see ``register``
+ method above). There may be other elements in tuple, depending on platform
+ and version, so don't assume that its size is 2. In case of timeout, an
+ empty list is returned.
Timeout is in milliseconds.