Skip to content

Commit eadfd56

Browse files
Wire: Fix method name in comment
This method was renamed shortly before merging this code and it seems some comments were note updated.
1 parent 7b6e6af commit eadfd56

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

libraries/Wire/src/Wire.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,15 @@ void TwoWire::setClock(uint32_t clock)
9999
* master that has claimed the bus).
100100
*
101101
* When a timeout is triggered, a flag is set that can be queried with `getWireTimeoutFlag()` and is cleared
102-
* when `clearWireTimeoutFlag()` or `setWireTimeoutUs()` is called.
102+
* when `clearWireTimeoutFlag()` or `setWireTimeout()` is called.
103103
*
104104
* Note that this timeout can also trigger while waiting for clock stretching or waiting for a second master
105105
* to complete its transaction. So make sure to adapt the timeout to accomodate for those cases if needed.
106106
* A typical timeout would be 25ms (which is the maximum clock stretching allowed by the SMBus protocol),
107107
* but (much) shorter values will usually also work.
108108
*
109109
* In the future, a timeout will be enabled by default, so if you require the timeout to be disabled, it is
110-
* recommended you disable it by default using `setWireTimeoutUs(0)`, even though that is currently
110+
* recommended you disable it by default using `setWireTimeout(0)`, even though that is currently
111111
* the default.
112112
*
113113
* @param timeout a timeout value in microseconds, if zero then timeout checking is disabled

0 commit comments

Comments
 (0)