docs: Add documentation of order policies (dotnet#2920)

filzrev · timcassell · web-flow · commit 80e68c1076c5 · 2025-12-13T07:13:49.000-05:00
* docs: add documentation for OrderPolicy

* Update docs/articles/configs/orderers.md

---------

Co-authored-by: Tim Cassell &lt;cassell.timothy@gmail.com&gt;
diff --git a/docs/articles/configs/orderers.md b/docs/articles/configs/orderers.md
@@ -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)]
diff --git a/samples/BenchmarkDotNet.Samples/IntroOrderAttr.cs b/samples/BenchmarkDotNet.Samples/IntroOrderAttr.cs
@@ -4,7 +4,7 @@
 
 namespace BenchmarkDotNet.Samples
 {
-    [Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared)]
+    [Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared, jobOrderPolicy: JobOrderPolicy.Default)]
     [DryJob]
     public class IntroOrderAttr
     {

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace BenchmarkDotNet.Samples`
`6`	`6`	`{`
`7`		`- [Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared)]`
	`7`	`+ [Orderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared, jobOrderPolicy: JobOrderPolicy.Default)]`
`8`	`8`	`[DryJob]`
`9`	`9`	`public class IntroOrderAttr`
`10`	`10`	`{`