Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FR] Improve docs for naming of benchmark arguments #1661

Open
pdroalves opened this issue Sep 7, 2023 · 1 comment
Open

[FR] Improve docs for naming of benchmark arguments #1661

pdroalves opened this issue Sep 7, 2023 · 1 comment
Labels
docs documentation update needed good first issue

Comments

@pdroalves
Copy link

Is your feature request related to a problem? Please describe.
I have benchmarks that need to be executed for different input parameter sets composed by many integer attributes. Today the output line for each benchmark is just the concatenation of the fixture name, the benchmark name, and all the numerical attributes. For instance:

MyFixture/MyImportantBenchmark/744/2048

This is terrible to read since the user may not know what each number relates to.

Describe the solution you'd like
I would like to have the possibility to use a name generator, just as googletest has, to customize this. So that line could become

MyFixture/MyImportantBenchmark/foo_744/bar_2048
@LebedevRI
Copy link
Collaborator

That already works, see ArgName() and ArgNames() (#305)
Please consider contributing a documentation for this, since it is clearly missing.

@LebedevRI LebedevRI changed the title [FR] Improve naming of benchmarks [FR] Improve docs for naming of benchmark arguments Sep 7, 2023
@dmah42 dmah42 added the docs documentation update needed label Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation update needed good first issue
Projects
None yet
Development

No branches or pull requests

3 participants