From 23dbd28f714281ec7af6f50fa56d23fbe4e0c569 Mon Sep 17 00:00:00 2001
From: Viktor Sonesten <v@tmplt.dev>
Date: Fri, 3 Dec 2021 11:54:51 +0100
Subject: [PATCH] timestamps: document panic

---
 itm/src/lib.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/itm/src/lib.rs b/itm/src/lib.rs
index effd4df..1b24475 100644
--- 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)
     }