Skip to content

docs: document benchmark argument names#2180

Merged
dmah42 merged 1 commit intogoogle:mainfrom
shreejaykurhade:docs-argument-names
Apr 26, 2026
Merged

docs: document benchmark argument names#2180
dmah42 merged 1 commit intogoogle:mainfrom
shreejaykurhade:docs-argument-names

Conversation

@shreejaykurhade
Copy link
Copy Markdown
Contributor

Summary

Documents how to use ArgName and ArgNames to make generated benchmark names easier to read when benchmarks use numeric arguments.

Fixes #1661

Details

  • Adds a Naming Benchmark Arguments subsection to the user guide.
  • Shows ArgName for single-argument benchmarks.
  • Shows ArgNames for benchmarks with multiple arguments.
  • Documents the existing output format, such as BM_SetInsert/size:100/inserts:128.
  • Notes that empty argument names leave that value unlabeled.

@shreejaykurhade
Copy link
Copy Markdown
Contributor Author

@dmah42 please review

@dmah42 dmah42 merged commit ec0ce39 into google:main Apr 26, 2026
83 of 84 checks passed
@LebedevRI
Copy link
Copy Markdown
Collaborator

Thank you!

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.

[FR] Improve docs for naming of benchmark arguments

3 participants