diff options
| author | Alex Tran <alex.t.tran@gmail.com> | 2025-11-24 16:57:00 -0800 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2025-11-26 14:41:55 +1100 |
| commit | 9b3b3a53ed52340809f9b87f0c215bbd8e87f9a9 (patch) | |
| tree | 0c525a6955e831c1af208c99ddf1dfe2eea73e44 | |
| parent | 1c47db32e4096c4fdb978771ef108d93bff28ace (diff) | |
docs/library: Fix typos under I2CTarget irq method description.
There were a few typos in the documentation for the `I2CTarget.irq` method
description where `IRQ_ADDR_MATCH_READ` was used, however
`IRQ_ADDR_MATCH_WRITE` should have been used.
Fixes issue #18470.
Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
| -rw-r--r-- | docs/library/machine.I2CTarget.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/machine.I2CTarget.rst b/docs/library/machine.I2CTarget.rst index 0e4af84cb..2765b9814 100644 --- a/docs/library/machine.I2CTarget.rst +++ b/docs/library/machine.I2CTarget.rst @@ -126,7 +126,7 @@ General Methods - ``IRQ_ADDR_MATCH_READ`` indicates that the target was addressed by a controller for a read transaction. - - ``IRQ_ADDR_MATCH_READ`` indicates that the target was addressed by a + - ``IRQ_ADDR_MATCH_WRITE`` indicates that the target was addressed by a controller for a write transaction. - ``IRQ_READ_REQ`` indicates that the controller is requesting data, and this request must be satisfied by calling `I2CTarget.write` with the data to be @@ -141,7 +141,7 @@ General Methods Note the following restrictions: - - ``IRQ_ADDR_MATCH_READ``, ``IRQ_ADDR_MATCH_READ``, ``IRQ_READ_REQ`` and + - ``IRQ_ADDR_MATCH_READ``, ``IRQ_ADDR_MATCH_WRITE``, ``IRQ_READ_REQ`` and ``IRQ_WRITE_REQ`` must be handled by a hard IRQ callback (with the *hard* argument set to ``True``). This is because these events have very strict timing requirements and must usually be satisfied synchronously with the hardware event. |