Fix function comments based on best practices from Effective Go (#428)

Signed-off-by: CodeLingo Bot <bot@codelingo.io>

diff --git a/history.go b/history.go
index d567a4e1b061a73f5b71578e235c8a4203160210..52e02c01d0387f7a097d72b2fe3c21d724f794d0 100644 (file)
--- a/history.go
+++ b/history.go
@@ -54,7 +54,7 @@ func (rh *resultHistory) Add(moduleName, target, debugOutput string, success boo
        }
 }
 
-// Return a list of all results.
+// List returns a list of all results.
 func (rh *resultHistory) List() []*result {
        rh.mu.Lock()
        defer rh.mu.Unlock()
@@ -62,7 +62,7 @@ func (rh *resultHistory) List() []*result {
        return rh.results[:]
 }
 
-// Return a given result.
+// Get returns a given result.
 func (rh *resultHistory) Get(id int64) *result {
        rh.mu.Lock()
        defer rh.mu.Unlock()

diff --git a/main.go b/main.go
index b9f159a18ff9fe3338821899ef9793468fedc79a..58ba88b280402b5dc1b89f4566cfc4cc54503654 100644 (file)
--- a/main.go
+++ b/main.go
@@ -162,7 +162,7 @@ func (sl scrapeLogger) Log(keyvals ...interface{}) error {
        return sl.next.Log(kvs...)
 }
 
-// Returns plaintext debug output for a probe.
+// DebugOutput returns plaintext debug output for a probe.
 func DebugOutput(module *config.Module, logBuffer *bytes.Buffer, registry *prometheus.Registry) string {
        buf := &bytes.Buffer{}
        fmt.Fprintf(buf, "Logs for the probe:\n")