From 6d291786a9c9686a3997d93c513bd18326611fe5 Mon Sep 17 00:00:00 2001
From: Philippe-Cholet <phcholet@orange.fr>
Date: Mon, 13 Nov 2023 19:11:59 +0100
Subject: [PATCH] Document the field `a_cur` of `Product`

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

diff --git a/src/adaptors/mod.rs b/src/adaptors/mod.rs
index e3b6d0f28..e925db51d 100644
--- 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,