Skip to content

Commit fa2a5b4

Browse files
authored
Docs: Rename DelayUs to DelayNs in docs for macros. (#908)
1 parent 4060c3d commit fa2a5b4

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

rtic-time/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ For each category, *Added*, *Changed*, *Fixed* add new entries at the top!
1313

1414
### Fixed
1515

16+
- Docs: Rename `DelayUs` to `DelayNs` in docs.
17+
1618
## v1.3.0 - 2024-01-10
1719

1820
### Changed

rtic-time/src/monotonic.rs

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,11 @@ pub trait Monotonic {
7373
fn disable_timer() {}
7474
}
7575

76-
/// Creates impl blocks for `embedded_hal::delay::DelayUs`,
77-
/// based on `fugit::ExtU64Ceil`.
76+
/// Creates impl blocks for [`embedded_hal::delay::DelayNs`][DelayNs],
77+
/// based on [`fugit::ExtU64Ceil`][ExtU64Ceil].
78+
///
79+
/// [DelayNs]: https://docs.rs/embedded-hal/latest/embedded_hal/delay/trait.DelayNs.html
80+
/// [ExtU64Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU64Ceil.html
7881
#[macro_export]
7982
macro_rules! embedded_hal_delay_impl_fugit64 {
8083
($t:ty) => {
@@ -121,8 +124,11 @@ macro_rules! embedded_hal_delay_impl_fugit64 {
121124
};
122125
}
123126

124-
/// Creates impl blocks for `embedded_hal_async::delay::DelayUs`,
125-
/// based on `fugit::ExtU64Ceil`.
127+
/// Creates impl blocks for [`embedded_hal_async::delay::DelayNs`][DelayNs],
128+
/// based on [`fugit::ExtU64Ceil`][ExtU64Ceil].
129+
///
130+
/// [DelayNs]: https://docs.rs/embedded-hal-async/latest/embedded_hal_async/delay/trait.DelayNs.html
131+
/// [ExtU64Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU64Ceil.html
126132
#[macro_export]
127133
macro_rules! embedded_hal_async_delay_impl_fugit64 {
128134
($t:ty) => {
@@ -148,8 +154,11 @@ macro_rules! embedded_hal_async_delay_impl_fugit64 {
148154
};
149155
}
150156

151-
/// Creates impl blocks for `embedded_hal::delay::DelayUs`,
152-
/// based on `fugit::ExtU32Ceil`.
157+
/// Creates impl blocks for [`embedded_hal::delay::DelayNs`][DelayNs],
158+
/// based on [`fugit::ExtU32Ceil`][ExtU32Ceil].
159+
///
160+
/// [DelayNs]: https://docs.rs/embedded-hal/latest/embedded_hal/delay/trait.DelayNs.html
161+
/// [ExtU32Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU32Ceil.html
153162
#[macro_export]
154163
macro_rules! embedded_hal_delay_impl_fugit32 {
155164
($t:ty) => {
@@ -196,8 +205,11 @@ macro_rules! embedded_hal_delay_impl_fugit32 {
196205
};
197206
}
198207

199-
/// Creates impl blocks for `embedded_hal_async::delay::DelayUs`,
200-
/// based on `fugit::ExtU32Ceil`.
208+
/// Creates impl blocks for [`embedded_hal_async::delay::DelayNs`][DelayNs],
209+
/// based on [`fugit::ExtU32Ceil`][ExtU32Ceil].
210+
///
211+
/// [DelayNs]: https://docs.rs/embedded-hal-async/latest/embedded_hal_async/delay/trait.DelayNs.html
212+
/// [ExtU32Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU32Ceil.html
201213
#[macro_export]
202214
macro_rules! embedded_hal_async_delay_impl_fugit32 {
203215
($t:ty) => {

rtic-time/tests/delay_precision_subtick.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ fn timer_queue_subtick_precision() {
273273
// then we will actually wait c subticks.
274274
// The important part is that c is never smaller than b,
275275
// in all cases, as that would violate the contract of
276-
// embedded-hal's DelayUs.
276+
// embedded-hal's DelayNs.
277277

278278
subtick_test!(0, 0, 0);
279279
subtick_test!(0, 1, 20);

0 commit comments

Comments
 (0)