Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-05 03:30:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity

docs/library: Fix typos under I2CTarget irq method description.

Browse Source 
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>
This commit is contained in:
Alex Tran
2025-11-24 16:57:00 -08:00
committed by Damien George
parent 1c47db32e4
commit 9b3b3a53ed
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/library/machine.I2CTarget.rst
View File

@@ -126,7 +126,7 @@ General Methods
- ``IRQ_ADDR_MATCH_READ`` indicates that the target was addressed by a - ``IRQ_ADDR_MATCH_READ`` indicates that the target was addressed by a
controller for a read transaction. 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. controller for a write transaction.
- ``IRQ_READ_REQ`` indicates that the controller is requesting data, and this - ``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 request must be satisfied by calling `I2CTarget.write` with the data to be
@@ -141,7 +141,7 @@ General Methods
Note the following restrictions: 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 ``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 set to ``True``). This is because these events have very strict timing requirements
and must usually be satisfied synchronously with the hardware event. and must usually be satisfied synchronously with the hardware event.