From aa700a8b42a1e6b89baf016ee496b85bddff6cd1 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Tue, 29 Aug 2017 11:06:59 -0700 Subject: [PATCH] shared-bindings: Clarify that UART.read() is slow. (#209) --- shared-bindings/busio/UART.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/shared-bindings/busio/UART.c b/shared-bindings/busio/UART.c index 0939910dcf..ee23ff0553 100644 --- a/shared-bindings/busio/UART.c +++ b/shared-bindings/busio/UART.c @@ -147,7 +147,9 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(busio_uart___exit___obj, 4, 4, busio_ //| .. method:: read(nbytes=None) //| //| Read characters. If ``nbytes`` is specified then read at most that many -//| bytes. Otherwise, read everything that has been buffered. +//| bytes. Otherwise, read everything that arrives until the connection +//| times out. Providing the number of bytes expected is highly recommended +//| because it will be faster. //| //| :return: Data read //| :rtype: bytes or None