From 2441b7e38978f3fa8d555ee85f2632176e0a2c86 Mon Sep 17 00:00:00 2001 From: Emil Fresk Date: Wed, 13 Nov 2019 20:56:31 +0100 Subject: [PATCH] Minor docs update to monotonic --- src/lib.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index d661c54f67..614ba853af 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -128,10 +128,12 @@ pub struct Fraction { /// A monotonic clock / counter pub trait Monotonic { - /// A measurement of this clock + /// A measurement of this clock, use `CYCCNT` as a reference implementation for `Instant`. + /// Note that the Instant must be a signed value such as `i32`. type Instant: Copy + Ord + Sub; - /// The ratio between the SysTick (system timer) frequency and this clock frequency + /// The ratio between the system timer (SysTick) frequency and this clock frequency, i.e. + /// `Monotonic clock * Fraction = System clock` /// /// The ratio must be expressed in *reduced* `Fraction` form to prevent overflows. That is /// `2 / 3` instead of `4 / 6`