docs: fix spammer latency CSV example name - #239
Open
UfukNode wants to merge 1 commit into
Open
Conversation
osr21
approved these changes
Aug 8, 2026
osr21
left a comment
There was a problem hiding this comment.
Verified against the source and this checks out completely:
- The spammer writes
tx_latency_{}.csvwithchrono::Utc::now().format("%Y%m%d_%H%M%S")— and it does so at both construction sites inspammer.rs(~line 164 and ~511), so the underscore/timestamp format is the only format the binary can ever produce. The oldtx-latency-1234567890.csvexamples (hyphens + what looks like a unix epoch) match neither the separator nor the timestamp scheme — likely a leftover from an earlier iteration of the tracker. - Nice touch reusing
tx_latency_20260310_151123.csvverbatim from the README's own "Output" section (line ~438): the doc now shows one consistent example filename from generation through analysis, so a reader can literally trace the same file across sections. - The remaining
data.csvplaceholders in the subcommand examples are correctly left alone — those are deliberately generic, andtx_latency_report.pytakes whatever--csvpath it's given (no filename-pattern assumptions in the script), so nothing else in that section needed touching.
Small observation on why this survived: the stale examples were internally consistent (all three identical), which is exactly the kind of wrong-but-coherent doc that passes casual review. The fix inherits the doc's real defense — the example now derives from the format string the code uses, so a future rename of the CSV pattern will at least have a greppable tx_latency_ prefix linking code and README.
Approving — three-line docs fix, verified against both code paths that write the file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Noticed the spammer latency docs describe generated files as
tx_latency_<yyyymmdd>_<hhmmss>.csv, but the analysis examples used a differenttx-latency-...name.Updated the examples to use the same filename format that the spammer actually writes.
Testing:
git diff --checkpython3 scripts/test_tx_latency_report.py