Improve code documentation

2020-10-23 16:12:53 -04:00
parent 4e3856c638
commit 0b1f20d0de
3 changed files with 16 additions and 4 deletions
--- a/metric/metric.go
+++ b/metric/metric.go
@ -15,6 +15,8 @@ var (
 	rwLock sync.RWMutex
 )

+// PublishMetricsForService publishes metrics for the given service and its result.
+// These metrics will be exposed at /metrics if the metrics are enabled
 func PublishMetricsForService(service *core.Service, result *core.Result) {
 	if config.Get().Metrics {
 		rwLock.Lock()