docs/select: Rename to uselect, to match the actual module name.

Also, add ipoll() documentation and markup changes to comply with CPython usage.
micropython · Jun 16, 2017 · 9469697 · 9469697
1 parent 396d6f6
commit 9469697
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 20 deletions.
diff --git a/docs/library/index.rst b/docs/library/index.rst
@@ -72,7 +72,6 @@ it will fallback to loading the built-in ``ujson`` module.
        cmath.rst
        gc.rst
        math.rst
-       select.rst
        sys.rst
        ubinascii.rst
        ucollections.rst
@@ -82,6 +81,7 @@ it will fallback to loading the built-in ``ujson`` module.
        ujson.rst
        uos.rst
        ure.rst
+       uselect.rst
        usocket.rst
        ustruct.rst
        utime.rst
@@ -97,7 +97,6 @@ it will fallback to loading the built-in ``ujson`` module.
        cmath.rst
        gc.rst
        math.rst
-       select.rst
        sys.rst
        ubinascii.rst
        ucollections.rst
@@ -107,6 +106,7 @@ it will fallback to loading the built-in ``ujson`` module.
        ujson.rst
        uos.rst
        ure.rst
+       uselect.rst
        usocket.rst
        ustruct.rst
        utime.rst
@@ -120,12 +120,12 @@ it will fallback to loading the built-in ``ujson`` module.
        builtins.rst
        array.rst
        gc.rst
-       select.rst
        sys.rst
        ubinascii.rst
        ujson.rst
        uos.rst
        ure.rst
+       uselect.rst
        usocket.rst
        ussl.rst
        utime.rst
@@ -148,6 +148,7 @@ it will fallback to loading the built-in ``ujson`` module.
        ujson.rst
        uos.rst
        ure.rst
+       uselect.rst
        usocket.rst
        ussl.rst
        ustruct.rst

diff --git a/docs/library/select.rst → docs/library/uselect.rst b/docs/library/select.rst → docs/library/uselect.rst
@@ -1,18 +1,11 @@
-:mod:`select` -- wait for events on a set of streams
+:mod:`uselect` -- wait for events on a set of streams
 ========================================================================
 
-.. module:: select
+.. module:: uselect
    :synopsis: wait for events on a set of streams
 
-This module provides functions to wait for events on streams (select streams
-which are ready for operations).
-
-Pyboard specifics
------------------
-
-Polling is an efficient way of waiting for read/write activity on multiple
-objects.  Current objects that support polling are: :class:`pyb.UART`,
-:class:`pyb.USB_VCP`.
+This module provides functions to efficiently wait for events on multiple
+streams (select streams which are ready for operations).
 
 Functions
 ---------
@@ -25,8 +18,8 @@ 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.
+   This function is provided by some MicroPython ports for compatibility
+   and is not efficient. Usage of :class:`Poll` is recommended instead.
 
 .. _class: Poll
 
@@ -38,22 +31,22 @@ Methods
 
 .. method:: poll.register(obj[, eventmask])
 
-   Register ``obj`` for polling. ``eventmask`` is logical OR of:
+   Register *obj* for polling. *eventmask* is logical OR of:
 
    * ``select.POLLIN``  - data available for reading
    * ``select.POLLOUT`` - more data can be written
    * ``select.POLLERR`` - error occurred
    * ``select.POLLHUP`` - end of stream/connection termination detected
 
-   ``eventmask`` defaults to ``select.POLLIN | select.POLLOUT``.
+   *eventmask* defaults to ``select.POLLIN | select.POLLOUT``.
 
 .. method:: poll.unregister(obj)
 
-   Unregister ``obj`` from polling.
+   Unregister *obj* from polling.
 
 .. method:: poll.modify(obj, eventmask)
 
-   Modify the ``eventmask`` for ``obj``.
+   Modify the *eventmask* for *obj*.
 
 .. method:: poll.poll([timeout])
 
@@ -65,3 +58,19 @@ Methods
    timeout, an empty list is returned.
 
    Timeout is in milliseconds.
+
+   .. admonition:: Difference to CPython
+      :class: attention
+
+      Tuples returned may contain more than 2 elements as described above.
+
+.. method:: poll.ipoll([timeout])
+
+   Like :meth:`poll.poll`, but instead returns an iterator which yields
+   callee-owned tuples. This function provides efficient, allocation-free
+   way to poll on streams.
+
+   .. admonition:: Difference to CPython
+      :class: attention
+
+      This function is a MicroPython extension.