From d7e6bab9fd0ad79130692f8e48e21375362a7614 Mon Sep 17 00:00:00 2001
From: Philippe-Cholet <phcholet@orange.fr>
Date: Mon, 13 Nov 2023 18:26:45 +0100
Subject: [PATCH] Document the field `peek` of `IntersperseWith`

---
 src/intersperse.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/intersperse.rs b/src/intersperse.rs
index 9f68a12bf..5f4f7938a 100644
--- a/src/intersperse.rs
+++ b/src/intersperse.rs
@@ -54,6 +54,9 @@ where
 {
     element: ElemF,
     iter: Fuse<I>,
+    /// `peek` is None while no item have been taken out of `iter` (at definition).
+    /// Then `peek` will alternatively be `Some(None)` and `Some(Some(item))`,
+    /// where `None` indicates it's time to generate from `element` (unless `iter` is empty).
     peek: Option<Option<I::Item>>,
 }