add comment

Signed-off-by: jyu6 <[email protected]>
jy4096 · Feb 2, 2023 · 2f3797d · 2f3797d
1 parent d253692
commit 2f3797d
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/pkg/watermark/ot/ot.go b/pkg/watermark/ot/ot.go
@@ -26,7 +26,10 @@ import (
 type Value struct {
 	Offset    int64
 	Watermark int64
-	Idle      bool
+	// Idle is set to true if the given processor entity hasn't published anything
+	// to the offset timeline bucket in a batch processing cycle.
+	// Idle is used to signal an idle watermark.
+	Idle bool
 }
 
 // EncodeToBytes encodes a Value object into byte array.