Docs & rules

dotnet/BenchmarkDotNetGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

1 stale name in these docs.

master36abf67Last read Oct 5

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
8
8
8
6
1 stale name
1
5
1
1
1
1
26 docs
dotnet/BenchmarkDotNetOpen repository

Stale names in these docs1

Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

  • GoneISummaryStyle
    The CSV exporter and other compatible exporters may consume an instance of ISummaryStyle that defines how the output should look like:

    The repository once had src/BenchmarkDotNet/Reports/ISummaryStyle.cs. It doesn't now. Closest name there: SummaryStyle.

    View on GitHub

dotnet/BenchmarkDotNet — documented rules

8 of 8 rules, printed November 17, 2026.

The sentence in your docs
You can also use a custom orderer by implementing the <xref:BenchmarkDotNet.Order.IOrderer> interface.
IOrderer is a contract
Holds
PackagesPath — packages restore path.
NativeAotSettings has PackagesPath
Holds
GenerateStackTraceData — generate stack trace metadata.
NativeAotSettings has GenerateStackTraceData
Holds
OptimizationPreference — "Speed" (default), "Size", or "" for none.
NativeAotSettings has OptimizationPreference
Holds
InstructionSet — instruction set for the target OS, architecture and hardware.
NativeAotSettings has InstructionSet
Holds
RuntimeIdentifier — the target runtime identifier (RID).
NativeAotSettings has RuntimeIdentifier
Holds
To configure the new diagnoser you need to create an instance of EtwProfilerConfig class and pass it to the EtwProfiler constructor.
EtwProfiler depends on EtwProfilerConfig
HoldsPR #912 · Sep 30
You can get the current version from the source code via BenchmarkDotNetInfo.FullVersion and the full title via BenchmarkDotNetInfo.FullTitle.
BenchmarkDotNetInfo has FullVersion
Holds
8 rules from 4 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.