penkovsky_sa/cherrypick
1
0
Fork 0
mirror of https://github.com/pese-git/cherrypick.git synced 2026-01-24 05:25:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(report): add legend to MarkdownReport output with explanation of columns

Browse Source
This commit is contained in:
Sergey Penkovsky
2025-08-06 22:53:33 +03:00
parent 1e6375f5ae
commit 01d82e1cd3
3 changed files with 35 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
benchmark_cherrypick/lib/cli/report/markdown_report.dart
View File

@@ -45,12 +45,27 @@ class MarkdownReport extends ReportGenerator {
});
String rowToLine(List<String> row, {String sep = ' | '}) =>
'| ' + List.generate(row.length, (i) => row[i].padRight(widths[i])).join(sep) + ' |';
'| ${List.generate(row.length, (i) => row[i].padRight(widths[i])).join(sep)} |';
final headerLine = rowToLine(headers);
final divider = '| ' + widths.map((w) => '-' * w).join(' | ') + ' |';
final divider = '| ${widths.map((w) => '-' * w).join(' | ')} |';
final lines = dataRows.map(rowToLine).toList();
return ([headerLine, divider] + lines).join('\n');
final legend = '''
> **Legend:**
> `Benchmark` – Test name
> `Chain Count` – Number of independent chains
> `Depth` – Depth of each chain
> `Mean (us)` – Average time per run (microseconds)
> `Median` – Median time per run
> `Stddev` – Standard deviation
> `Min`, `Max` – Min/max run time
> `N` – Number of measurements
> `ΔRSS(KB)` – Change in process memory (KB)
> `ΔPeak(KB)` – Change in peak RSS (KB)
> `PeakRSS(KB)` – Max observed RSS memory (KB)
''';
return '$legend\n\n${([headerLine, divider] + lines).join('\n')}' ;
}
}