timestamps: document panic

rtic-scope · Dec 3, 2021 · 23dbd28 · 23dbd28
1 parent 6530e8c
commit 23dbd28
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/itm/src/lib.rs b/itm/src/lib.rs
@@ -549,6 +549,12 @@ where
     }
 
     /// Returns an iterator over [`TimestampedTracePackets`](TimestampedTracePackets).
+    ///
+    /// # Panics
+    ///
+    /// This iterator constuctor will panic if
+    /// [`options.lts_prescaler`](TimestampsConfiguration::lts_prescaler)
+    /// is [`Disabled`](LocalTimestampOptions::Disabled).
     pub fn timestamps(&mut self, options: TimestampsConfiguration) -> Timestamps<R> {
         Timestamps::new(self, options)
     }