diff options
| author | Lorenz Schmid <lorenzschmid@users.noreply.github.com> | 2016-12-14 23:07:42 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2016-12-15 09:59:32 +1100 |
| commit | 0caac94b986bb0b08918b68d48feb4c5a0c4991c (patch) | |
| tree | 064b7d370803d3894cd66f979bdaf2b29a80024b | |
| parent | c16e7eae5ed0d6611d82370a693fb33b31455c39 (diff) | |
| download | micropython-0caac94b986bb0b08918b68d48feb4c5a0c4991c.tar.gz micropython-0caac94b986bb0b08918b68d48feb4c5a0c4991c.zip | |
docs/library/pyb.UART: Added clarification about timeouts.
| -rw-r--r-- | docs/library/pyb.UART.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst index b6c0d1a20f..4f63c648f8 100644 --- a/docs/library/pyb.UART.rst +++ b/docs/library/pyb.UART.rst @@ -87,8 +87,8 @@ Methods - ``stop`` is the number of stop bits, 1 or 2. - ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS`` or ``UART.RTS | UART.CTS``. - - ``timeout`` is the timeout in milliseconds to wait for the first character. - - ``timeout_char`` is the timeout in milliseconds to wait between characters. + - ``timeout`` is the timeout in milliseconds to wait for writing/reading the first character. + - ``timeout_char`` is the timeout in milliseconds to wait between characters while writing or reading. - ``read_buf_len`` is the character length of the read buffer (0 to disable). This method will raise an exception if the baudrate could not be set within |