dotnet / dotnet/BenchmarkDotNet
Description replaces Method name column in exporter
- Dominant language
- C#
- Stars
- 11.5k
- Forks
- 1.1k
- Avg merge
- 6d 11h
- Merged PRs (30d)
- 12
Description
If I set a description on a benchmark, I lose the method name in the generated CSV.
The method name is in a way the unique identifier of the benchmark, whereas a description is merely describing what the benchmark is meant to test, and not guaranteed to be unique either.
Could we instead of having a single "Method" column, have two: `Method` and `Description` so the output could have both? It becomes rather important when storing daily benchmarks in a database that the "ID" of the benchmark stays unique and consistent, but a description can be allowed to change any time.
I assume this behavior is caused by this line:
https://github.com/dotnet/BenchmarkDotNet/blob/ea0468f7d611a5c750f3e079cfab0f28bcd9169b/src/BenchmarkDotNet/Running/Descriptor.cs#L54
But it's misleading in the report output to have the description listed under "Method"
Contributor guide
Assessment
This issue has not been assessed yet.