summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2018-08-04 16:00:06 +1000
committerDamien George <damien.p.george@gmail.com>2018-08-14 15:21:54 +1000
commitb18fa1e606b2880684ec1d97f4d00494c5137472 (patch)
treee21c7bdbf96895cc6ecc608916585ffbcdf88c60
parentfe1ef507ef6fe9bb35cef4df354b06005cc0737d (diff)
docs/library/machine.UART.rst: Specify optional txbuf and rxbuf args.
If a port would like to expose the configuration of transmit and/or receive buffers then it can use these arguments.
-rw-r--r--docs/library/machine.UART.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst
index 998b738c3..5fcdc2758 100644
--- a/docs/library/machine.UART.rst
+++ b/docs/library/machine.UART.rst
@@ -56,6 +56,8 @@ Methods
- *tx* specifies the TX pin to use.
- *rx* specifies the RX pin to use.
+ - *txbuf* specifies the length in characters of the TX buffer.
+ - *rxbuf* specifies the length in characters of the RX buffer.
On the WiPy only the following keyword-only parameter is supported: