docs: select: Describe poll.poll() return value in detail.

This commit is contained in:
Paul Sokolovsky 2015-10-29 22:08:10 +03:00
parent 9b12bc788f
commit 98b6d35c4f
1 changed files with 5 additions and 1 deletions

View File

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