diff options
| author | Scott Shawcroft <scott@tannewt.org> | 2017-08-29 11:06:59 -0700 |
|---|---|---|
| committer | Dan Halbert <halbert@halwitz.org> | 2017-08-29 14:06:59 -0400 |
| commit | aa700a8b42a1e6b89baf016ee496b85bddff6cd1 (patch) | |
| tree | 49ca7c1ba656b1b3d3a9dc31b5995cd224d3a684 | |
| parent | 447a4b1ecd5655357c9daaace03b91355d2e2c6d (diff) | |
shared-bindings: Clarify that UART.read() is slow. (#209)
| -rw-r--r-- | shared-bindings/busio/UART.c | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/shared-bindings/busio/UART.c b/shared-bindings/busio/UART.c index 0939910dc..ee23ff055 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 |