Skip to content

Commit

Permalink
Benchmarks Guide: Update statistical term links (#3531)
Browse files Browse the repository at this point in the history
  • Loading branch information
gregory-paidis-sonarsource authored Jan 5, 2024
1 parent 6fe3e11 commit 96fed93
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/benchmarks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

|===
| <What is being measured> | 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]
| <What is being measured> | Mean | Standard Deviation | Allocated
| <This> | 5.042 ms | 0.1049 ms | 125 KB
| <That> | 2.691 ms | 0.0334 ms | 85.94 KB
|===
Expand Down

0 comments on commit 96fed93

Please sign in to comment.