Skip to content

docs(output): explain mean and sigma - #999

Open
cyncui wants to merge 1 commit into
sharkdp:masterfrom
cyncui:docs/explain-timing-summary
Open

cyncui wants to merge 1 commit into
sharkdp:masterfrom
cyncui:docs/explain-timing-summary

Conversation

@cyncui

@cyncui cyncui commented Oct 8, 2026

Copy link
Copy Markdown

why

hyperfine labels mean and σ in its results, but the docs do not explain that σ describes variation between runs rather than uncertainty in the mean. closes #443.

what changed

  • explain the average, corrected sample standard deviation, and single-run output in the readme and man page.

scope

  • documentation only. measurement and output behavior stay the same.

blast radius

  • this changes guidance for readers and has no runtime effect.

verification

  • cargo +stable test --locked --quiet passed all 132 tests.
  • cargo +stable fmt --all --check and clippy with -D warnings passed.
  • the built cli showed mean ± σ for three runs and value for one run. mandoc rendered the new section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document hyperfine's output fields

1 participant