Document the field a_cur of Product

rust-itertools · Nov 13, 2023 · 6d29178 · 6d29178
1 parent bf2b012
commit 6d29178
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/adaptors/mod.rs b/src/adaptors/mod.rs
@@ -308,6 +308,9 @@ where
     I: Iterator,
 {
     a: I,
+    /// `a_cur` is `None` while no item have been taken out of `a` (at definition).
+    /// Then `a_cur` will be `Some(Some(item))` until `a` is exhausted,
+    /// in which case `a_cur` will be `Some(None)`.
     a_cur: Option<Option<I::Item>>,
     b: J,
     b_orig: J,