diff options
| author | Gram <mail@orsinium.dev> | 2024-03-24 18:15:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-24 17:15:57 +0000 |
| commit | fa2a5b449f1746b4b3bb3da08dab532ee24ba286 (patch) | |
| tree | 57b1d1cc63c4cab90e25e572b466c1fe90c980f2 /rtic-time | |
| parent | 4060c3def88f82d4e4f48de7137ce365167ef265 (diff) | |
Docs: Rename `DelayUs` to `DelayNs` in docs for macros. (#908)
Diffstat (limited to 'rtic-time')
| -rw-r--r-- | rtic-time/CHANGELOG.md | 2 | ||||
| -rw-r--r-- | rtic-time/src/monotonic.rs | 28 | ||||
| -rw-r--r-- | rtic-time/tests/delay_precision_subtick.rs | 2 |
3 files changed, 23 insertions, 9 deletions
diff --git a/rtic-time/CHANGELOG.md b/rtic-time/CHANGELOG.md index b4a25d4..f3c9792 100644 --- a/rtic-time/CHANGELOG.md +++ b/rtic-time/CHANGELOG.md @@ -13,6 +13,8 @@ For each category, *Added*, *Changed*, *Fixed* add new entries at the top! ### Fixed +- Docs: Rename `DelayUs` to `DelayNs` in docs. + ## v1.3.0 - 2024-01-10 ### Changed diff --git a/rtic-time/src/monotonic.rs b/rtic-time/src/monotonic.rs index 0e8d2b8..e6a160d 100644 --- a/rtic-time/src/monotonic.rs +++ b/rtic-time/src/monotonic.rs @@ -73,8 +73,11 @@ pub trait Monotonic { fn disable_timer() {} } -/// Creates impl blocks for `embedded_hal::delay::DelayUs`, -/// based on `fugit::ExtU64Ceil`. +/// Creates impl blocks for [`embedded_hal::delay::DelayNs`][DelayNs], +/// based on [`fugit::ExtU64Ceil`][ExtU64Ceil]. +/// +/// [DelayNs]: https://docs.rs/embedded-hal/latest/embedded_hal/delay/trait.DelayNs.html +/// [ExtU64Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU64Ceil.html #[macro_export] macro_rules! embedded_hal_delay_impl_fugit64 { ($t:ty) => { @@ -121,8 +124,11 @@ macro_rules! embedded_hal_delay_impl_fugit64 { }; } -/// Creates impl blocks for `embedded_hal_async::delay::DelayUs`, -/// based on `fugit::ExtU64Ceil`. +/// Creates impl blocks for [`embedded_hal_async::delay::DelayNs`][DelayNs], +/// based on [`fugit::ExtU64Ceil`][ExtU64Ceil]. +/// +/// [DelayNs]: https://docs.rs/embedded-hal-async/latest/embedded_hal_async/delay/trait.DelayNs.html +/// [ExtU64Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU64Ceil.html #[macro_export] macro_rules! embedded_hal_async_delay_impl_fugit64 { ($t:ty) => { @@ -148,8 +154,11 @@ macro_rules! embedded_hal_async_delay_impl_fugit64 { }; } -/// Creates impl blocks for `embedded_hal::delay::DelayUs`, -/// based on `fugit::ExtU32Ceil`. +/// Creates impl blocks for [`embedded_hal::delay::DelayNs`][DelayNs], +/// based on [`fugit::ExtU32Ceil`][ExtU32Ceil]. +/// +/// [DelayNs]: https://docs.rs/embedded-hal/latest/embedded_hal/delay/trait.DelayNs.html +/// [ExtU32Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU32Ceil.html #[macro_export] macro_rules! embedded_hal_delay_impl_fugit32 { ($t:ty) => { @@ -196,8 +205,11 @@ macro_rules! embedded_hal_delay_impl_fugit32 { }; } -/// Creates impl blocks for `embedded_hal_async::delay::DelayUs`, -/// based on `fugit::ExtU32Ceil`. +/// Creates impl blocks for [`embedded_hal_async::delay::DelayNs`][DelayNs], +/// based on [`fugit::ExtU32Ceil`][ExtU32Ceil]. +/// +/// [DelayNs]: https://docs.rs/embedded-hal-async/latest/embedded_hal_async/delay/trait.DelayNs.html +/// [ExtU32Ceil]: https://docs.rs/fugit/latest/fugit/trait.ExtU32Ceil.html #[macro_export] macro_rules! embedded_hal_async_delay_impl_fugit32 { ($t:ty) => { diff --git a/rtic-time/tests/delay_precision_subtick.rs b/rtic-time/tests/delay_precision_subtick.rs index 4db889c..a4ef4bb 100644 --- a/rtic-time/tests/delay_precision_subtick.rs +++ b/rtic-time/tests/delay_precision_subtick.rs @@ -273,7 +273,7 @@ fn timer_queue_subtick_precision() { // then we will actually wait c subticks. // The important part is that c is never smaller than b, // in all cases, as that would violate the contract of - // embedded-hal's DelayUs. + // embedded-hal's DelayNs. subtick_test!(0, 0, 0); subtick_test!(0, 1, 20); |