Skip to content

Commit ae4887b

Browse files
committed
Fix documentation formatting for ARC trace reader by escaping square brackets in the description of the size parameter.
1 parent c6d7904 commit ae4887b

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

tracekit-formats/src/arc.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! text format used in cache simulation research. Each line contains:
66
//!
77
//! ```text
8-
//! timestamp key [size]
8+
//! timestamp key \[size\]
99
//! ```
1010
//!
1111
//! - `timestamp`: Unix timestamp or logical time (ignored in basic simulation)
@@ -27,7 +27,7 @@
2727
use std::io::BufRead;
2828
use tracekit::{Event, EventSource};
2929

30-
/// Reads traces in ARC format (space-separated: timestamp key [size]).
30+
/// Reads traces in ARC format (space-separated: timestamp key \[size\]).
3131
pub struct ArcReader<R> {
3232
reader: R,
3333
line: String,
@@ -71,7 +71,7 @@ impl<R: BufRead> EventSource for ArcReader<R> {
7171
continue; // Invalid line, skip
7272
}
7373

74-
// Parse: timestamp key [size]
74+
// Parse: timestamp key \[size\]
7575
let key = match parts[1].parse::<u64>() {
7676
Ok(k) => k,
7777
Err(_) => continue, // Skip invalid key

0 commit comments

Comments
 (0)