Reiterate on display and include comments

Author: zhouselena

internal/cmd/perfcomp/main.go

@@ -321,11 +321,15 @@ func generatePRComment(energyStats []*EnergyStats, version string) string {
 	fmt.Fprintf(&comment, "The following benchmark tests for version %s had statistically significant changes (i.e., |z-score| > 1.96):\n\n", version)
 
 	w := tabwriter.NewWriter(&comment, 0, 0, 1, ' ', 0)
-	fmt.Fprintln(w, "| Benchmark\t| Measurement\t| H-Score\t| Z-Score\t| % Change\t| Stable Reg\t| Patch Value\t|")
-	fmt.Fprintln(w, "| ---------\t| -----------\t| -------\t| -------\t| --------\t| ----------\t| -----------\t|")
+	fmt.Fprintln(w, "| Benchmark\t| Measurement\t| % Change\t| Patch Value\t| Stable Region\t| H-Score\t| Z-Score\t| ")
+	fmt.Fprintln(w, "| ---------\t| -----------\t| --------\t| -----------\t| -------------\t| -------\t| -------\t|")
 
 	var significantEnergyStats []EnergyStats
 	for _, es := range energyStats {
+		// The "iterations" measurement is the number of iterations that the Go
+		// benchmark suite had to run to converge on a benchmark measurement. It
+		// is not comparable between benchmark runs, so is not a useful
+		// measurement to print here. Omit it.
 		if es.Measurement != "iterations" && math.Abs(es.ZScore) > 1.96 {
 			significantEnergyStats = append(significantEnergyStats, *es)
 		}
@@ -339,7 +343,7 @@ func generatePRComment(energyStats []*EnergyStats, version string) string {
 			return math.Abs(significantEnergyStats[i].PercentChange) > math.Abs(significantEnergyStats[j].PercentChange)
 		})
 		for _, es := range significantEnergyStats {
-			fmt.Fprintf(w, "| %s\t| %s\t| %.4f\t| %.4f\t| %.4f\t| Avg: %.4f, Med: %.4f, Stdev: %.4f\t| %.4f\t|\n", es.Benchmark, es.Measurement, es.HScore, es.ZScore, es.PercentChange, es.StableRegion.Mean, es.StableRegion.Median, es.StableRegion.Std, es.MeasurementVal)
+			fmt.Fprintf(w, "| %s\t| %s\t| %.4f\t| %.4f\t| Avg: %.4f, Med: %.4f, Stdev: %.4f\t| %.4f\t| %.4f\t|\n", es.Benchmark, es.Measurement, es.PercentChange, es.MeasurementVal, es.StableRegion.Mean, es.StableRegion.Median, es.StableRegion.Std, es.HScore, es.ZScore)
 		}
 	}
 	w.Flush()

internal/cmd/perfcomp/parseperfcomp/main.go

@@ -19,6 +19,8 @@ const parsePerfCompDir = "./internal/cmd/perfcomp/parseperfcomp/"
 const perfReportFileTxt = "perf-report.txt"
 const perfReportFileMd = "perf-report.md"
 const perfVariant = "^perf$"
+const hscoreDefLink = "https://en.wikipedia.org/wiki/Energy_distance#:~:text=E%2Dcoefficient%20of%20inhomogeneity"
+const zscoreDefLink = "https://en.wikipedia.org/wiki/Standard_score#Calculation"
 
 func main() {
 	var line string
@@ -71,6 +73,15 @@ func main() {
 			} else {
 				printUrlToLine(fWrite, line, evgLink, "Evergreen", 0)
 			}
+		} else if strings.Contains(line, ", ") {
+			line = strings.ReplaceAll(line, ", ", "<br>")
+			fmt.Fprintf(fWrite, "%s\n", line)
+		} else if strings.Contains(line, "H-Score") {
+			linkedWord := "[H-Score](" + hscoreDefLink + ")"
+			line = strings.ReplaceAll(line, "H-Score", linkedWord)
+			linkedWord = "[Z-Score](" + zscoreDefLink + ")"
+			line = strings.ReplaceAll(line, "Z-Score", linkedWord)
+			fmt.Fprintf(fWrite, "%s\n", line)
 		} else {
 			// all other regular lines
 			fmt.Fprintf(fWrite, "%s\n", line)