include mod description

delta-io · Jan 13, 2025 · ad85ff7 · ad85ff7
1 parent 9a228ed
commit ad85ff7
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/kernel/src/log_segment/delta_log_group_iterator.rs b/kernel/src/log_segment/delta_log_group_iterator.rs
@@ -1,3 +1,5 @@
+//! An iterator that groups [`ParsedLogPath`]s by version.
+
 use tracing::warn;
 
 use crate::log_segment::ParsedLogPath;
@@ -6,7 +8,8 @@ use crate::Version;
 use std::iter::Peekable;
 
 /**
- * An iterator that groups [`ParsedLogPath`]s by version.
+ * The [`DeltaLogGroupingIterator`] is a utility iterator that groups log paths.
+ * It takes an iterator of [`ParsedLogPath`]s and groups them by version.
  * For example for an input iterator:
  * - 11.checkpoint.0.1.parquet
  * - 11.checkpoint.1.1.parquet