Skip to content

Commit 406e067

Browse files
authored
fix(rmt): rephasing
Clarify behavior of rmtTransmitCompleted in looping mode.
1 parent 380504a commit 406e067

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/en/api/rmt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ This function returns ``true`` when all data has been sent and the channel is re
216216

217217
**Note:**
218218
* If ``rmtWrite()`` times out or ``rmtWriteAsync()`` is called, this function will return ``false`` until all data is sent out.
219-
* ``rmtTransmitCompleted()`` will always return ``true`` when ``rmtWriteLooping()`` is active, because looping mode never completes.
219+
* ``rmtTransmitCompleted()`` will always return ``true`` when ``rmtWriteLooping()`` is active, because it has no effect in such case.
220220

221221
rmtRead
222222
*******

0 commit comments

Comments
 (0)