shared-bindings: Clarify that UART.read() is slow. (#209)

5 years ago · aa700a8b42
parent 447a4b1ecd
commit aa700a8b42
1 changed files with 3 additions and 1 deletions
--- 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