Skip to content

Commit

Permalink
misc: Fix warnings with MicroPython 1.20 documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
kwagyeman committed Jul 19, 2023
1 parent 34d3b01 commit 7c483c3
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 23 deletions.
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@
"rp2/quickref.rst",
"rp2/tutorial/intro.rst",
"rp2/tutorial/pio.rst",
"samd/general.rst",
"samd/quickref.rst",
"samd/pinout.rst",
"samd/tutorial/intro.rst",
"unix/quickref.rst",
"zephyr/general.rst",
"zephyr/quickref.rst",
Expand Down
1 change: 1 addition & 0 deletions docs/genrst/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ above. The sections below describe the current status of these features.
../differences/python_37.rst
../differences/python_38.rst
../differences/python_39.rst
../differences/python_310.rst

For the features of Python that are implemented by MicroPython, there are
sometimes differences in their behaviour compared to standard Python. The
Expand Down
23 changes: 0 additions & 23 deletions docs/library/machine.UART.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,29 +145,6 @@ Methods
Send a break condition on the bus. This drives the bus low for a duration
longer than required for a normal transmission of a character.

.. method:: UART.flush()

Waits until all data has been sent. In case of a timeout, an exception is raised. The timeout
duration depends on the tx buffer size and the baud rate. Unless flow control is enabled, a timeout
should not occur.

.. method:: UART.txdone()

.. note::

The handler will be called whenever any of the following two conditions are met:

- 8 new characters have been received.
- At least 1 new character is waiting in the Rx buffer and the Rx line has been
silent for the duration of 1 complete frame.

This means that when the handler function is called there will be between 1 to 8
characters waiting.

Returns an irq object.

Availability: WiPy.

.. method:: UART.flush()

Waits until all data has been sent. In case of a timeout, an exception is raised. The timeout
Expand Down

0 comments on commit 7c483c3

Please sign in to comment.