Skip to content

docs: explain benchmark summary statistics - #913

Open
ColumbusLabs wants to merge 1 commit into
sharkdp:masterfrom
ColumbusLabs:codex/hyperfine-443-output-docs
Open

docs: explain benchmark summary statistics#913
ColumbusLabs wants to merge 1 commit into
sharkdp:masterfrom
ColumbusLabs:codex/hyperfine-443-output-docs

Conversation

@ColumbusLabs

Copy link
Copy Markdown

Closes #443.

Summary

  • explain that Time reports the mean wall-clock duration across timed runs
  • define σ as the corrected sample standard deviation and describe what its size conveys
  • explain that User and System are average CPU-time components
  • keep the README and manpage wording aligned

Validation

  • cargo test --locked (102 passing)
  • cargo fmt -- --check
  • rendered manpage inspection
  • mandoc lint reported no diagnostics on the added lines
  • git diff --check

Windows CPU-time wording was verified from the job-object implementation; runtime verification was performed on the local platform.

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