aboutsummaryrefslogtreecommitdiff
path: root/rtic-time
diff options
context:
space:
mode:
Diffstat (limited to 'rtic-time')
-rw-r--r--rtic-time/CHANGELOG.md2
-rw-r--r--rtic-time/src/half_period_counter.rs6
2 files changed, 6 insertions, 2 deletions
diff --git a/rtic-time/CHANGELOG.md b/rtic-time/CHANGELOG.md
index 15ebf5b2..2e02a9d0 100644
--- a/rtic-time/CHANGELOG.md
+++ b/rtic-time/CHANGELOG.md
@@ -11,6 +11,8 @@ For each category, *Added*, *Changed*, *Fixed* add new entries at the top!
### Changed
+- Docs: Add sanity check to `half_period_counter` code example
+
### Fixed
## v1.1.0 - 2023-12-04
diff --git a/rtic-time/src/half_period_counter.rs b/rtic-time/src/half_period_counter.rs
index 5d3bf752..0aaec5e2 100644
--- a/rtic-time/src/half_period_counter.rs
+++ b/rtic-time/src/half_period_counter.rs
@@ -96,11 +96,13 @@
//! fn on_interrupt() {
//! if overflow_interrupt_happened() {
//! clear_overflow_interrupt();
-//! HALF_PERIOD_COUNTER.fetch_add(1, Ordering::Relaxed);
+//! let prev = HALF_PERIOD_COUNTER.fetch_add(1, Ordering::Relaxed);
+//! assert!(prev % 2 == 1, "Monotonic must have skipped an interrupt!");
//! }
//! if compare_interrupt_happened() {
//! clear_compare_interrupt();
-//! HALF_PERIOD_COUNTER.fetch_add(1, Ordering::Relaxed);
+//! let prev = HALF_PERIOD_COUNTER.fetch_add(1, Ordering::Relaxed);
+//! assert!(prev % 2 == 0, "Monotonic must have skipped an interrupt!");
//! }
//! }
//!