Skip to content

Commit 0caac94

Browse files
lorenzschmiddpgeorge
authored andcommitted
docs/library/pyb.UART: Added clarification about timeouts.
1 parent c16e7ea commit 0caac94

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/library/pyb.UART.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ Methods
8787
- ``stop`` is the number of stop bits, 1 or 2.
8888
- ``flow`` sets the flow control type. Can be 0, ``UART.RTS``, ``UART.CTS``
8989
or ``UART.RTS | UART.CTS``.
90-
- ``timeout`` is the timeout in milliseconds to wait for the first character.
91-
- ``timeout_char`` is the timeout in milliseconds to wait between characters.
90+
- ``timeout`` is the timeout in milliseconds to wait for writing/reading the first character.
91+
- ``timeout_char`` is the timeout in milliseconds to wait between characters while writing or reading.
9292
- ``read_buf_len`` is the character length of the read buffer (0 to disable).
9393

9494
This method will raise an exception if the baudrate could not be set within

0 commit comments

Comments
 (0)