From 9521399044e128b0d3692d110c26b1ff6a27330e Mon Sep 17 00:00:00 2001 From: Yonatan Goldschmidt Date: Sun, 24 Feb 2019 00:13:51 +0200 Subject: [PATCH] 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`. --- docs/library/uos.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/library/uos.rst b/docs/library/uos.rst index c073f079d7..c7460134b1 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.