Skip to content

Commit

Permalink
docs/uos: Document extra requirements on stream objs passed to dupterm.
Browse files Browse the repository at this point in the history
This is only correct for the extmod/uos_dupterm.c implementation however,
as e.g cc3200 implementation does the mp_load_method() itself, and anyway
requires `read` instead of `readinto`.
  • Loading branch information
Jongy authored and dpgeorge committed Feb 25, 2019
1 parent 21f9329 commit 9521399
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/library/uos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ Terminal redirection and duplication
.. function:: dupterm(stream_object, index=0)

Duplicate or switch the MicroPython terminal (the REPL) on the given `stream`-like
object. The *stream_object* argument must implement the ``readinto()`` and
object. The *stream_object* argument must be a native stream object, or derive
from ``uio.IOBase`` and implement the ``readinto()`` and
``write()`` methods. The stream should be in non-blocking mode and
``readinto()`` should return ``None`` if there is no data available for reading.

Expand Down

0 comments on commit 9521399

Please sign in to comment.