From 96fed93d7b175810c7510a77a608a743f735ad27 Mon Sep 17 00:00:00 2001 From: Gregory Paidis <115458417+gregory-paidis-sonarsource@users.noreply.github.com> Date: Fri, 5 Jan 2024 13:52:54 +0100 Subject: [PATCH] Benchmarks Guide: Update statistical term links (#3531) --- docs/benchmarks.adoc | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/benchmarks.adoc b/docs/benchmarks.adoc index 20de97b8d84..13e30bf2993 100644 --- a/docs/benchmarks.adoc +++ b/docs/benchmarks.adoc @@ -11,12 +11,18 @@ The format of the benchmarks section is as follows: == Benchmark table - Do not use abbreviations for statistical terms, not everyone is familiar with them. -- Add links to Wikipedia to explain statistical terms at the header of each column. +- In the `Benchmarks` section, add a subsection called `Glossary` right after the benchmark table and add links to Wikipedia to explain statistical terms used in the header of each column: -Ideally, the columns should look like the following example: +==== Glossary + +* https://en.wikipedia.org/wiki/Arithmetic_mean[Mean] +* https://en.wikipedia.org/wiki/Standard_deviation[Standard Deviation] +* https://en.wikipedia.org/wiki/Memory_management[Allocated] + +Ideally, the columns should look like in the following example: |=== -| | https://en.wikipedia.org/wiki/Arithmetic_mean[Mean] | https://en.wikipedia.org/wiki/Standard_deviation[Standard Deviation] | https://en.wikipedia.org/wiki/Memory_management[Allocated] +| | Mean | Standard Deviation | Allocated | | 5.042 ms | 0.1049 ms | 125 KB | | 2.691 ms | 0.0334 ms | 85.94 KB |===