ishangsf/rspec
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Benchmarks Guide: Update statistical term links (#3531)

Browse Source
This commit is contained in:
Gregory Paidis 2024-01-05 13:52:54 +01:00 committed by GitHub
parent 6fe3e11073
commit 96fed93d7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/benchmarks.adoc
View File

@ -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
|===