Skip to content

docs: Add documentation of order policies #2920

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.

Sign up for GitHub

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

Merged
timcassell merged 2 commits into from
Dec 13, 2025
+8 −1
Merged

docs: Add documentation of order policies #2920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc89f65
docs: add documentation for OrderPolicy
filzrev Dec 12, 2025
d781afd
Update docs/articles/configs/orderers.md
timcassell Dec 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/articles/configs/orderers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ name: Orderers

Orderers allows customizing the order of benchmark results in the summary table.

The following built-in order policies are available.
- <xref:BenchmarkDotNet.Order.SummaryOrderPolicy>
- <xref:BenchmarkDotNet.Order.MethodOrderPolicy>
- <xref:BenchmarkDotNet.Order.JobOrderPolicy>

You can also use a custom orderer by implementing the <xref:BenchmarkDotNet.Order.IOrderer> interface.

---

[!include[IntroOrderAttr](../samples/IntroOrderAttr.md)]
Expand Down
2 changes: 1 addition & 1 deletion samples/BenchmarkDotNet.Samples/IntroOrderAttr.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

namespace BenchmarkDotNet.Samples
{
[Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared)]
[Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared, jobOrderPolicy: JobOrderPolicy.Default)]
[DryJob]
public class IntroOrderAttr
{
Expand Down
Loading