From a09e93ecc565bcc357c8aa5e2ae71d6aa37ad566 Mon Sep 17 00:00:00 2001 From: Dan Upton Date: Fri, 18 Mar 2022 19:58:30 +0000 Subject: [PATCH] Clarify doc comments Co-authored-by: Chris S. Kim --- saturation.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/saturation.go b/saturation.go index 38ba2a93c..47c01fa3b 100644 --- a/saturation.go +++ b/saturation.go @@ -14,7 +14,7 @@ import ( // Callers must instrument their loop with calls to sleeping and working, starting // with a call to sleeping. // -// Note: it is expected that the caller is single-threaded and is not safe for +// Note: the caller must be single-threaded and saturationMetric is not safe for // concurrent use by multiple goroutines. type saturationMetric struct { reportInterval time.Duration @@ -40,9 +40,9 @@ type saturationMetricBucket struct { // than working. slept time.Duration - // lost contains time that was lost due to incorrect instrumentation of the - // event processing loop (e.g. calling sleeping() or working() multiple times - // in succession). + // lost contains time that is considered lost due to incorrect use + // of saturationMetricBucket (e.g. calling sleeping() or working() + // multiple times in succession). lost time.Duration }