From 67eca7253b13a3ab74f592fc3cbfe56c866a37f7 Mon Sep 17 00:00:00 2001 From: leo Date: Tue, 27 Dec 2022 01:04:55 +0100 Subject: [PATCH] chore(go): comment exported symbols --- algo/algo.go | 3 +++ bench/functions.go | 1 + 2 files changed, 4 insertions(+) diff --git a/algo/algo.go b/algo/algo.go index d1cadfd..64757a2 100644 --- a/algo/algo.go +++ b/algo/algo.go @@ -45,6 +45,9 @@ func GetMeanStats() *stats.MeanStats { return meanStats } +// PrepComparisonOfMeans returns a pointer to a slice of pics (of type +// report.PicList) and an integer - the count of unique benchmarking functions +// used. func PrepComparisonOfMeans(wg *sync.WaitGroup) (*report.PicList, int) { pL := report.NewPicList() meanStats := GetMeanStats() diff --git a/bench/functions.go b/bench/functions.go index a1be7ae..d4836eb 100644 --- a/bench/functions.go +++ b/bench/functions.go @@ -13,6 +13,7 @@ var Functions = map[string]func([]float64) float64{ "De Jong 2nd": DeJong2nd, } +// FuncNames represents a numbered list of function name. var FuncNames = map[int]string{ 0: "Schwefel", 1: "De Jong 1st",