Merge pull request #1388 from nnethercote/github-table-tweaks

GitHub comment table tweaks

Author: nnethercote

site/src/comparison.rs

@@ -525,7 +525,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)
@@ -555,14 +555,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()
@@ -620,6 +620,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 { "" }),
@@ -636,20 +638,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);
     }
 }
 
@@ -1376,9 +1371,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(),
@@ -1396,10 +1391,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(),
@@ -1417,11 +1412,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(),
         );
@@ -1438,11 +1433,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(),
         );
@@ -1461,9 +1456,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(),
@@ -1505,9 +1500,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(),
@@ -1525,9 +1520,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(),