8000 docs: select: Describe poll.poll() return value in detail. · micropython/micropython@98b6d35 · GitHub
[go: up one dir, main page]

Skip to content

Commit 98b6d35

Browse files
author
Paul Sokolovsky
committed
docs: select: Describe poll.poll() return value in detail.
1 parent 9b12bc7 commit 98b6d35

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/library/select.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ Methods
5252
.. method:: poll.poll([timeout])
5353

5454
Wait for at least one of the registered objects to become ready. Returns
55-
list of ready objects, or empty list on timeout.
55+
list of (``obj``, ``event``, ...) tuples, ``event`` element specifying
56+
whether ``obj`` is ready for reading, writing, or both (see ``register``
57+
method above). There may be other elements in tuple, depending on platform
58+
and version, so don't assume that its size is 2. In case of timeout, an
59+
empty list is returned.
5660

5761
Timeout is in milliseconds.

0 commit comments

Comments
 (0)
0