dotnet / dotnet/BenchmarkDotNet

Request to Improve Documentation

Open
#2,290 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
11.5k
Forks
1.1k
Avg merge
4d 11h
Merged PRs (30d)
11

Description

I found a thread that describes some key details about how BenchmarkDotNet works [here](https://github.com/dotnet/performance/blob/main/docs/microbenchmark-design-guidelines.md#benchmarkdotnet). I think that it would be helpful to make this information easy to find in the documentation. Maybe the [Overview](https://benchmarkdotnet.org/articles/overview.html) or the [How it Works](https://benchmarkdotnet.org/articles/guides/how-it-works.html) page.

Also, I think a little more information on the statistical heuristic that is used to determine the number of iterations would be helpful. Does it use standard error of the mean as described [here](https://statisticsbyjim.com/hypothesis-testing/standard-error-mean/)? Also, knowing that there is a min and max iteration count is helpful in this context.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.