Skip to content

Commit b0b4f46

Browse files
committed
A few more doc cleanups
1 parent 7bcaa87 commit b0b4f46

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

embedded-hal-bus/src/i2c/critical_section.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use embedded_hal::i2c::{ErrorType, I2c};
44

55
/// `critical-section`-based shared bus [`I2c`] implementation.
66
///
7-
/// Sharing is implemented with a `critical-section` [`Mutex`](critical_section::Mutex). A critical section is taken for
7+
/// Sharing is implemented with a `critical-section` [`Mutex`]. A critical section is taken for
88
/// the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels).
99
/// The downside is critical sections typically require globally disabling interrupts, so `CriticalSectionDevice` will likely
1010
/// negatively impact real-time properties, such as interrupt latency. If you can, prefer using

embedded-hal-bus/src/i2c/mutex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::sync::Mutex;
33

44
/// `std` `Mutex`-based shared bus [`I2c`] implementation.
55
///
6-
/// Sharing is implemented with an `std` [`Mutex`](std::sync::Mutex). It allows a single bus across multiple threads,
6+
/// Sharing is implemented with an `std` [`Mutex`]. It allows a single bus across multiple threads,
77
/// with finer-grained locking than [`CriticalSectionDevice`](super::CriticalSectionDevice). The downside is that
88
/// it is only available in `std` targets.
99
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]

embedded-hal-bus/src/spi/critical_section.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ use super::DeviceError;
88

99
/// `critical-section`-based shared bus [`SpiDevice`] implementation.
1010
///
11-
/// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus), obtaining multiple [`SpiDevice`] instances,
11+
/// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
1212
/// each with its own `CS` pin.
1313
///
14-
/// Sharing is implemented with a `critical-section` [`Mutex`](critical_section::Mutex). A critical section is taken for
14+
/// Sharing is implemented with a `critical-section` [`Mutex`]. A critical section is taken for
1515
/// the entire duration of a transaction. This allows sharing a single bus across multiple threads (interrupt priority levels).
1616
/// The downside is critical sections typically require globally disabling interrupts, so `CriticalSectionDevice` will likely
1717
/// negatively impact real-time properties, such as interrupt latency. If you can, prefer using

embedded-hal-bus/src/spi/exclusive.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use super::DeviceError;
1313

1414
/// [`SpiDevice`] implementation with exclusive access to the bus (not shared).
1515
///
16-
/// This is the most straightforward way of obtaining an [`SpiDevice`] from an [`SpiBus`](embedded_hal::spi::SpiBus),
16+
/// This is the most straightforward way of obtaining an [`SpiDevice`] from an [`SpiBus`],
1717
/// ideal for when no sharing is required (only one SPI device is present on the bus).
1818
pub struct ExclusiveDevice<BUS, CS, D> {
1919
bus: BUS,

embedded-hal-bus/src/spi/mutex.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ use super::DeviceError;
77

88
/// `std` `Mutex`-based shared bus [`SpiDevice`] implementation.
99
///
10-
/// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus), obtaining multiple [`SpiDevice`] instances,
10+
/// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
1111
/// each with its own `CS` pin.
1212
///
13-
/// Sharing is implemented with a `std` [`Mutex`](std::sync::Mutex). It allows a single bus across multiple threads,
13+
/// Sharing is implemented with a `std` [`Mutex`]. It allows a single bus across multiple threads,
1414
/// with finer-grained locking than [`CriticalSectionDevice`](super::CriticalSectionDevice). The downside is
1515
/// it is only available in `std` targets.
1616
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]

embedded-hal-bus/src/spi/refcell.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use super::DeviceError;
77

88
/// `RefCell`-based shared bus [`SpiDevice`] implementation.
99
///
10-
/// This allows for sharing an [`SpiBus`](embedded_hal::spi::SpiBus), obtaining multiple [`SpiDevice`] instances,
10+
/// This allows for sharing an [`SpiBus`], obtaining multiple [`SpiDevice`] instances,
1111
/// each with its own `CS` pin.
1212
///
1313
/// Sharing is implemented with a `RefCell`. This means it has low overhead, but `RefCellDevice` instances are not `Send`,

0 commit comments

Comments
 (0)