From 6212c61288e2dbb9e691876a852228128e4e3888 Mon Sep 17 00:00:00 2001
From: techmccat <alessioa02004@gmail.com>
Date: Tue, 13 Aug 2024 12:55:46 +0200
Subject: [PATCH] time: fix duration variable names, add doc

---
 src/time.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/time.rs b/src/time.rs
index a097d0e9..29dd234d 100644
--- a/src/time.rs
+++ b/src/time.rs
@@ -101,16 +101,18 @@ impl U32Ext for u32 {
     }
 }
 
+/// Converts clock cycles at a given frequency into a Duration with arbitrary fraction
 pub fn duration<const NOM: u32, const DENOM: u32>(
     hz: Hertz,
     cycles: u32,
 ) -> Duration<u32, NOM, DENOM> {
     let cycles = cycles as u64;
     let clk = hz.raw() as u64;
-    let us = cycles.saturating_mul(DENOM as u64) / clk / NOM as u64;
-    Duration::<u32, NOM, DENOM>::from_ticks(us as u32)
+    let duration_ticks = cycles.saturating_mul(DENOM as u64) / clk / NOM as u64;
+    Duration::<u32, NOM, DENOM>::from_ticks(duration_ticks as u32)
 }
 
+/// Converts a Duration with arbitrary fraction into a number of cycles at the specified frequency
 pub fn cycles<const NOM: u32, const DENOM: u32>(ms: Duration<u32, NOM, DENOM>, clk: Hertz) -> u32 {
     assert!(ms.ticks() > 0);
     let clk = clk.raw() as u64;