Remove GitHub comment footer.

These footnotes make the comment longer but they feel very low value to
me.

Author: nnethercote

site/src/comparison.rs

@@ -95,7 +95,7 @@ pub async fn handle_triage(
                     .clone()
                     .summarize_by_category(&benchmark_map);
                 let mut result = String::from("**Summary**:\n\n");
-                write_summary_table(&primary, &secondary, false, true, &mut result);
+                write_summary_table(&primary, &secondary, true, &mut result);
                 result
             }
             None => String::from("**ERROR**: no data found for end bound"),
@@ -547,7 +547,7 @@ async fn write_triage_summary(
     let link = &compare_link(start, end);
     write!(&mut result, " [(Comparison Link)]({})\n\n", link).unwrap();
 
-    write_summary_table(&primary, &secondary, false, true, &mut result);
+    write_summary_table(&primary, &secondary, true, &mut result);
 
     result
 }
@@ -556,7 +556,6 @@ async fn write_triage_summary(
 pub fn write_summary_table(
     primary: &ArtifactComparisonSummary,
     secondary: &ArtifactComparisonSummary,
-    with_footnotes: bool,
     include_metric: bool,
     result: &mut String,
 ) {
@@ -668,9 +667,9 @@ pub fn write_summary_table(
     // easy to read for anyone who is viewing the Markdown source.
     let column_labels = [
         metric,
-        format!("mean{}", if with_footnotes { "[^1]" } else { "" }),
+        format!("mean"),
         "range".to_string(),
-        format!("count{}", if with_footnotes { "[^2]" } else { "" }),
+        format!("count"),
     ];
     let counts: Vec<usize> = column_labels.iter().map(|s| s.chars().count()).collect();
     for column in &column_labels {
@@ -692,16 +691,6 @@ pub fn write_summary_table(
     }
 }
 
-pub fn write_summary_table_footer(result: &mut String) {
-    writeln!(
-        result,
-        r#"
-[^1]: *the arithmetic mean of the percent change*
-[^2]: *number of relevant changes*"#
-    )
-    .unwrap();
-}
-
 /// Compare two bounds on a given stat
 ///
 /// Returns Ok(None) when no data for the end bound is present
@@ -1437,11 +1426,11 @@ mod tests {
                 (Category::Primary, 1.0, 3.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | 146.7%   | [100.0%, 200.0%] | 3         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -        | -     | 0         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | 146.7%   | [100.0%, 200.0%] | 3         |
+| Regressions ❌ <br /> (primary) | 146.7% | [100.0%, 200.0%] | 3     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -    | -     | 0     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | 146.7% | [100.0%, 200.0%] | 3     |
 "#
             .trim_start(),
         );
@@ -1456,11 +1445,11 @@ mod tests {
                 (Category::Primary, 4.0, 1.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | -        | -     | 0         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -71.7%   | [-80.0%, -60.0%] | 3         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | -71.7%   | [-80.0%, -60.0%] | 3         |
+| Regressions ❌ <br /> (primary) | -    | -     | 0     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -71.7% | [-80.0%, -60.0%] | 3     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | -71.7% | [-80.0%, -60.0%] | 3     |
 "#
             .trim_start(),
         );
@@ -1475,11 +1464,11 @@ mod tests {
                 (Category::Secondary, 4.0, 1.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | -        | -     | 0         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -        | -     | 0         |
-| Improvements ✅ <br /> (secondary) | -71.7%   | [-80.0%, -60.0%] | 3         |
-| All ❌✅ (primary) | -        | -     | 0         |
+| Regressions ❌ <br /> (primary) | -    | -     | 0     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -    | -     | 0     |
+| Improvements ✅ <br /> (secondary) | -71.7% | [-80.0%, -60.0%] | 3     |
+| All ❌✅ (primary) | -    | -     | 0     |
 "#
             .trim_start(),
         );
@@ -1494,11 +1483,11 @@ mod tests {
                 (Category::Secondary, 1.0, 3.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | -        | -     | 0         |
-| Regressions ❌ <br /> (secondary) | 146.7%   | [100.0%, 200.0%] | 3         |
-| Improvements ✅ <br /> (primary) | -        | -     | 0         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | -        | -     | 0         |
+| Regressions ❌ <br /> (primary) | -    | -     | 0     |
+| Regressions ❌ <br /> (secondary) | 146.7% | [100.0%, 200.0%] | 3     |
+| Improvements ✅ <br /> (primary) | -    | -     | 0     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | -    | -     | 0     |
 "#
             .trim_start(),
         );
@@ -1514,11 +1503,11 @@ mod tests {
                 (Category::Primary, 4.0, 1.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | 150.0%   | [100.0%, 200.0%] | 2         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -62.5%   | [-75.0%, -50.0%] | 2         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | 43.8%    | [-75.0%, 200.0%] | 4         |
+| Regressions ❌ <br /> (primary) | 150.0% | [100.0%, 200.0%] | 2     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -62.5% | [-75.0%, -50.0%] | 2     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | 43.8% | [-75.0%, 200.0%] | 4     |
 "#
             .trim_start(),
         );
@@ -1536,11 +1525,11 @@ mod tests {
                 (Category::Primary, 4.0, 1.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | 150.0%   | [100.0%, 200.0%] | 2         |
-| Regressions ❌ <br /> (secondary) | 100.0%   | [100.0%, 100.0%] | 1         |
-| Improvements ✅ <br /> (primary) | -62.5%   | [-75.0%, -50.0%] | 2         |
-| Improvements ✅ <br /> (secondary) | -66.7%   | [-66.7%, -66.7%] | 1         |
-| All ❌✅ (primary) | 43.8%    | [-75.0%, 200.0%] | 4         |
+| Regressions ❌ <br /> (primary) | 150.0% | [100.0%, 200.0%] | 2     |
+| Regressions ❌ <br /> (secondary) | 100.0% | [100.0%, 100.0%] | 1     |
+| Improvements ✅ <br /> (primary) | -62.5% | [-75.0%, -50.0%] | 2     |
+| Improvements ✅ <br /> (secondary) | -66.7% | [-66.7%, -66.7%] | 1     |
+| All ❌✅ (primary) | 43.8% | [-75.0%, 200.0%] | 4     |
 "#
             .trim_start(),
         );
@@ -1554,11 +1543,11 @@ mod tests {
                 (Category::Primary, 5.0, 6.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | 20.0%    | [20.0%, 20.0%] | 1         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -50.0%   | [-50.0%, -50.0%] | 1         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | -15.0%   | [-50.0%, 20.0%] | 2         |
+| Regressions ❌ <br /> (primary) | 20.0% | [20.0%, 20.0%] | 1     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -50.0% | [-50.0%, -50.0%] | 1     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | -15.0% | [-50.0%, 20.0%] | 2     |
 "#
             .trim_start(),
         );
@@ -1572,11 +1561,11 @@ mod tests {
                 (Category::Primary, 6.0, 5.0),
             ],
             r#"
-| Regressions ❌ <br /> (primary) | 100.0%   | [100.0%, 100.0%] | 1         |
-| Regressions ❌ <br /> (secondary) | -        | -     | 0         |
-| Improvements ✅ <br /> (primary) | -16.7%   | [-16.7%, -16.7%] | 1         |
-| Improvements ✅ <br /> (secondary) | -        | -     | 0         |
-| All ❌✅ (primary) | 41.7%    | [-16.7%, 100.0%] | 2         |
+| Regressions ❌ <br /> (primary) | 100.0% | [100.0%, 100.0%] | 1     |
+| Regressions ❌ <br /> (secondary) | -    | -     | 0     |
+| Improvements ✅ <br /> (primary) | -16.7% | [-16.7%, -16.7%] | 1     |
+| Improvements ✅ <br /> (secondary) | -    | -     | 0     |
+| All ❌✅ (primary) | 41.7% | [-16.7%, 100.0%] | 2     |
 "#
             .trim_start(),
         );
@@ -1625,8 +1614,8 @@ mod tests {
         let secondary = ArtifactComparisonSummary::summarize(secondary_comparisons);
 
         let mut result = String::new();
-        write_summary_table(&primary, &secondary, true, true, &mut result);
-        let header = "| (instructions:u) | mean[^1] | range | count[^2] |\n|:----------------:|:--------:|:-----:|:---------:|\n";
+        write_summary_table(&primary, &secondary, true, &mut result);
+        let header = "| (instructions:u) | mean | range | count |\n|:----------------:|:----:|:-----:|:-----:|\n";
         assert_eq!(result, format!("{header}{expected}"));
     }
 }

site/src/github/comparison_summary.rs

@@ -1,6 +1,6 @@
 use crate::comparison::{
-    deserves_attention_icount, write_summary_table, write_summary_table_footer, ArtifactComparison,
-    ArtifactComparisonSummary, Direction, Metric,
+    deserves_attention_icount, write_summary_table, ArtifactComparison, ArtifactComparisonSummary,
+    Direction, Metric,
 };
 use crate::load::SiteCtxt;
 
@@ -174,7 +174,6 @@ async fn summarize_run(
         }
     }
 
-    let mut table_written = false;
     let metrics = vec![
         (
             "Instruction count",
@@ -203,45 +202,38 @@ async fn summarize_run(
         ));
 
         let (primary, secondary) = comparison.summarize_by_category(&benchmark_map);
-        table_written |= write_metric_summary(primary, secondary, highly_reliable, &mut message);
-    }
-
-    if table_written {
-        write_summary_table_footer(&mut message);
+        write_metric_summary(primary, secondary, highly_reliable, &mut message);
     }
 
     Ok(message)
 }
 
-/// Returns true if a summary table was written to `message`.
 fn write_metric_summary(
     primary: ArtifactComparisonSummary,
     secondary: ArtifactComparisonSummary,
     highly_reliable: bool,
     message: &mut String,
-) -> bool {
+) {
     if !primary.is_relevant() && !secondary.is_relevant() {
         message
             .push_str("This benchmark run did not return any relevant results for this metric.\n");
-        false
     } else {
         if highly_reliable {
             message.push_str(
                 "This is a highly reliable metric that was used to determine the \
                 overall result at the top of this comment.\n\n",
             );
-            write_summary_table(&primary, &secondary, true, false, message);
+            write_summary_table(&primary, &secondary, false, message);
         } else {
             // `<details>` means it is hidden, requiring a click to reveal.
             message.push_str("<details>\n<summary>Results</summary>\n\n");
             message.push_str(
                 "This is a less reliable metric that may be of interest but was not \
                 used to determine the overall result at the top of this comment.\n\n",
             );
-            write_summary_table(&primary, &secondary, true, false, message);
+            write_summary_table(&primary, &secondary, false, message);
             message.push_str("</details>\n");
         }
-        true
     }
 }