Skip to content

Commit 03f2b54

Browse files
committed
Document delay operations are capped
1 parent 72d4487 commit 03f2b54

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/spi.rs

+9
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ use std::path::Path;
1010

1111
/// Newtype around [`spidev::Spidev`] that implements the `embedded-hal` traits
1212
///
13+
/// [Delay operations][delay] are capped to 65535 microseconds.
14+
///
1315
/// [`spidev::Spidev`]: https://docs.rs/spidev/0.5.2/spidev/struct.Spidev.html
16+
/// [delay]: embedded_hal::spi::Operation::DelayUs
1417
pub struct Spidev(pub spidev::Spidev);
1518

1619
impl Spidev {
@@ -79,6 +82,12 @@ mod embedded_hal_impl {
7982
}
8083

8184
impl SpiDevice for Spidev {
85+
///Perform a transaction against the device. [Read more][transaction]
86+
///
87+
/// [Delay operations][delay] are capped to 65535 microseconds.
88+
///
89+
/// [transaction]: SpiDevice::transaction
90+
/// [delay]: SpiOperation::DelayUs
8291
fn transaction(
8392
&mut self,
8493
operations: &mut [SpiOperation<'_, u8>],

0 commit comments

Comments
 (0)