Skip to content

Commit a0191ef

Browse files
committed
docs: Add doc comment to parse_single_log explaining CLI-specific implementation
Resolves coderabbitai feedback: - Explains why CLI has its own parse_single_log distinct from crate's version - Notes architectural difference: CLI stores all frames for CSV export - Crate stores only 10 sample frames for memory efficiency - References issue #16 Phase 5c for context
1 parent b67ffb5 commit a0191ef

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

src/main.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -598,6 +598,11 @@ fn parse_bbl_file(
598598
Ok(logs)
599599
}
600600

601+
/// Parse a single log from binary data.
602+
///
603+
/// Note: This CLI-specific implementation differs from the crate's `parse_single_log`
604+
/// because CSV export requires storing ALL frames, whereas the crate only stores
605+
/// 10 sample frames for memory efficiency. See issue #16 Phase 5c for details.
601606
fn parse_single_log(
602607
log_data: &[u8],
603608
log_number: usize,

0 commit comments

Comments
 (0)