djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/uos: Document extra requirements on stream objs passed to dupterm.

Browse Source 
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`.
This commit is contained in:
Yonatan Goldschmidt 2019-02-24 00:13:51 +02:00 committed by Damien George
parent 21f9329d5d
commit 9521399044
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/library/uos.rst
View File

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