Skip to content

Commit b8df447

Browse files
Update documentation for FullDuplex to try_ methods
1 parent ce8a7b9 commit b8df447

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/spi.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ use nb;
88
///
99
/// - It's the task of the user of this interface to manage the slave select lines
1010
///
11-
/// - Due to how full duplex SPI works each `read` call must be preceded by a `send` call.
11+
/// - Due to how full duplex SPI works each `try_read` call must be preceded by a `try_send` call.
1212
///
13-
/// - `read` calls only return the data received with the last `send` call.
13+
/// - `try_read` calls only return the data received with the last `send` call.
1414
/// Previously received data is discarded
1515
///
16-
/// - Data is only guaranteed to be clocked out when the `read` call succeeds.
16+
/// - Data is only guaranteed to be clocked out when the `try_read` call succeeds.
1717
/// The slave select line shouldn't be released before that.
1818
///
1919
/// - Some SPIs can work with 8-bit *and* 16-bit words. You can overload this trait with different

0 commit comments

Comments
 (0)