docs: document human-readable units for I/O byte fields#58
Merged
Conversation
PR #57 updated print_io_stats to format all byte-count fields using format_size_with_unit (B, KB, MB, GB) and extended that helper to support the GB range. Update docs to reflect this: - README.md: note that I/O byte-count fields show human-readable units - docs/TECHNICAL.md: add note clarifying which fields use unit formatting and which (syscr, syscw) remain raw counts - docs/TESTING.md: document unit-suffixed output expectation for I/O fields and add I/O Formatting Helpers subsection covering format_size_with_unit, calculate_avg_bytes_per_syscall, and calculate_io_intensity Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
automation
documentation
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
1 participant
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.
Summary
PR #57 changed
print_io_statsto format all byte-count fields with human-readable units (B, KB, MB, GB) viaformat_size_with_unit, and extended that helper to cover the GB range. This PR updates the docs to match.Changed files
README.mddocs/TECHNICAL.mdsyscr,syscw)docs/TESTING.mdformat_size_with_unit,calculate_avg_bytes_per_syscall, andcalculate_io_intensityNo code changes
Pure documentation update — no source or test files were modified.