Skip to content

GitHub comment table tweaks #1388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 11, 2022
Merged

GitHub comment table tweaks #1388

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27e726b
Use `-` instead of `N/A` for "no results".
nnethercote Aug 10, 2022
18dfc21
Remove an unnecessary closure.
nnethercote Aug 10, 2022
a47e42d
Add a comment.
nnethercote Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 29 additions & 34 deletions site/src/comparison.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ pub fn write_summary_table(
let value = if count > 0 { calculate() } else { None };
value
.map(|value| format!("{value:.1}%"))
.unwrap_or_else(|| "N/A".to_string())
.unwrap_or_else(|| "-".to_string())
}

// (label, mean, max, count)
Expand Down Expand Up @@ -521,14 +521,14 @@ pub fn write_summary_table(
Some(secondary.arithmetic_mean_of_improvements())
}),
if primary.is_empty() {
"N/A".to_string()
"-".to_string()
} else {
format!("{:.1}%", primary.arithmetic_mean_of_changes())
},
]);

let largest_change = if primary.is_empty() {
"N/A".to_string()
"-".to_string()
} else {
let largest_improvement = primary
.largest_improvement()
Expand Down Expand Up @@ -586,6 +586,8 @@ pub fn write_summary_table(
(primary.num_regressions + primary.num_improvements).to_string(),
]);

// This code attempts to space the table cells evenly so that the data is
// easy to read for anyone who is viewing the Markdown source.
let column_labels = [
" ".to_string(), // we want at least 10 spaces to accommodate "count[^2]"
format!("mean{}", if with_footnotes { "[^1]" } else { "" }),
Expand All @@ -602,20 +604,13 @@ pub fn write_summary_table(
}
result.push_str("|\n");

let mut render_row = |row: Vec<String>| {
debug_assert_eq!(row.len(), column_labels.len());
for (column, &count) in row.into_iter().zip(&counts) {
for row in 0..5 {
let row_data = column_data.iter().map(|rows| rows[row].clone());
debug_assert_eq!(row_data.len(), column_labels.len());
for (column, &count) in row_data.zip(&counts) {
write!(result, "| {:<1$} ", column, count).unwrap();
}
result.push_str("|\n");
};

for row in 0..5 {
let row_data = column_data
.iter()
.map(|rows| rows[row].clone())
.collect::<Vec<_>>();
render_row(row_data);
}
}

Expand Down Expand Up @@ -1341,9 +1336,9 @@ mod tests {
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | 146.7% | 200.0% | 3 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (primary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | - | - | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | 146.7% | 200.0% | 3 |
"#
.trim_start(),
Expand All @@ -1361,10 +1356,10 @@ mod tests {
r#"
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (primary) | - | - | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | -71.7% | -80.0% | 3 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | -71.7% | -80.0% | 3 |
"#
.trim_start(),
Expand All @@ -1382,11 +1377,11 @@ mod tests {
r#"
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (primary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (primary) | - | - | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | - | - | 0 |
| Improvements ✅ <br /> (secondary) | -71.7% | -80.0% | 3 |
| All ❌✅ (primary) | N/A | N/A | 0 |
| All ❌✅ (primary) | - | - | 0 |
"#
.trim_start(),
);
Expand All @@ -1403,11 +1398,11 @@ mod tests {
r#"
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (primary) | - | - | 0 |
| Regressions ❌ <br /> (secondary) | 146.7% | 200.0% | 3 |
| Improvements ✅ <br /> (primary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| All ❌✅ (primary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (primary) | - | - | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | - | - | 0 |
"#
.trim_start(),
);
Expand All @@ -1426,9 +1421,9 @@ mod tests {
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | 150.0% | 200.0% | 2 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | -62.5% | -75.0% | 2 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | 43.8% | 200.0% | 4 |
"#
.trim_start(),
Expand Down Expand Up @@ -1470,9 +1465,9 @@ mod tests {
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | 20.0% | 20.0% | 1 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | -50.0% | -50.0% | 1 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | -15.0% | -50.0% | 2 |
"#
.trim_start(),
Expand All @@ -1490,9 +1485,9 @@ mod tests {
| | mean[^1] | max | count[^2] |
|:----------:|:--------:|:---:|:---------:|
| Regressions ❌ <br /> (primary) | 100.0% | 100.0% | 1 |
| Regressions ❌ <br /> (secondary) | N/A | N/A | 0 |
| Regressions ❌ <br /> (secondary) | - | - | 0 |
| Improvements ✅ <br /> (primary) | -16.7% | -16.7% | 1 |
| Improvements ✅ <br /> (secondary) | N/A | N/A | 0 |
| Improvements ✅ <br /> (secondary) | - | - | 0 |
| All ❌✅ (primary) | 41.7% | 100.0% | 2 |
"#
.trim_start(),
Expand Down