From 7b168d6918cfc23819dcd263d31daca54bef73d4 Mon Sep 17 00:00:00 2001 From: David Brown Date: Tue, 10 Sep 2024 23:05:45 -0600 Subject: [PATCH] rust: Comment cleanup Comment cleanups. Fix several minor typos in the comments. Signed-off-by: David Brown --- lib/rust/zephyr/src/time.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/rust/zephyr/src/time.rs b/lib/rust/zephyr/src/time.rs index 4610449d34258a..7e6228e7421c82 100644 --- a/lib/rust/zephyr/src/time.rs +++ b/lib/rust/zephyr/src/time.rs @@ -45,7 +45,7 @@ pub type Tick = u64; #[cfg(not(CONFIG_TIMEOUT_64BIT))] pub type Tick = u32; -/// Duration appropraite for Zephyr calls that expect `k_timeout_t`. The result will be a time +/// Duration appropriate for Zephyr calls that expect `k_timeout_t`. The result will be a time /// interval from "now" (when the call is made). pub type Duration = fugit::Duration; @@ -54,7 +54,7 @@ pub type Duration = fugit::Duration; #[cfg(CONFIG_TIMEOUT_64BIT)] pub type Instant = fugit::Instant; -// The zephry k_timeout_t represents several different types of intervals, based on the range of +// The Zephyr `k_timeout_t` represents several different types of intervals, based on the range of // the value. It is a signed number of the same size as the Tick here, which effectively means it // is one bit less. // @@ -63,13 +63,13 @@ pub type Instant = fugit::Instant; // -1: K_FOREVER: a time that never expires. // MIN .. -2: A wait for an absolute amount of ticks from the start of the system. // -// The absolute time offset is only implemented when time is a 64 bit value. This also means that +// The absolute time offset is only implemented when time is a 64-bit value. This also means that // "Instant" isn't available when time is defined as a 32-bit value. // Wrapper around the timeout type, so we can implement From/Info. pub struct Timeout(pub k_timeout_t); -// From allows methods to take a time of various types and convert it into a Zephyr timeout. +// `From` allows methods to take a time of various types and convert it into a Zephyr timeout. impl From for Timeout { fn from(value: Duration) -> Timeout { let ticks: k_ticks_t = checked_cast(value.ticks());