aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYonatan Goldschmidt2019-02-24 00:13:51 +0200
committerDamien George2019-02-26 01:12:37 +1100
commit9521399044e128b0d3692d110c26b1ff6a27330e (patch)
treece3c8f6d31c48f87f43272dee449f84dca051e25 /docs
parent21f9329d5d69516064f0ad77af311ac31a6dd009 (diff)
docs/uos: Document extra requirements on stream objs passed to dupterm.
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`.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/uos.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/library/uos.rst b/docs/library/uos.rst
index c073f079d..c7460134b 100644
--- a/docs/library/uos.rst
+++ b/docs/library/uos.rst
@@ -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.