Skip to content

Commit

Permalink
Clarify doc comments
Browse files Browse the repository at this point in the history
Co-authored-by: Chris S. Kim <kisunji92@gmail.com>
  • Loading branch information
boxofrad and kisunji committed Mar 18, 2022
1 parent f8ea87a commit a09e93e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions saturation.go
Expand Up @@ -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
Expand All @@ -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
}

Expand Down

0 comments on commit a09e93e

Please sign in to comment.