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

naming for iterations and/or duration #65

Closed
heckj opened this issue Feb 26, 2023 · 1 comment · Fixed by #67
Closed

naming for iterations and/or duration #65

heckj opened this issue Feb 26, 2023 · 1 comment · Fixed by #67

Comments

@heckj
Copy link
Contributor

heckj commented Feb 26, 2023

Working through writing a few sample benchmarks, I was exploring Benchmark.defaultConfiguration.desiredIterations, Benchmark.defaultConfiguration.desiredDuration, and how they relate to each other.

I do think the names could be improved by renaming them to maxIterations and maxDuration, respectively. I'm also thinking that as we cobble the documentation, expanding on Benchmark.Configuration (and maybe the article WritingBenchmarks.md), it would be worth calling out specifically that the running will go until the first of these two are hit.

And just to double check - if you specify warmupIterations on the configuration, does that take place before either the iterations vs. duration markers are measured?

@hassila
Copy link
Contributor

hassila commented Feb 26, 2023

Agree it would be a nice improvement!

And just to double check - if you specify warmupIterations on the configuration, does that take place before either the iterations vs. duration markers are measured?

Yes it does, it's completely outside the measurement.

hassila added a commit that referenced this issue Feb 27, 2023
…tions/maxDuration (#67)

This fixes #65, it makes the point of use for these settings clearer.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants