rate: add documentation on Limiter concurrent usage

Closes golang/go#17261 Change-Id: Ifeacc8df45fb59e7781ddcc35c2fde0aa80188eb Reviewed-on: https://go-review.googlesource.com/c/time/+/530855 Auto-Submit: Sameer Ajmani <[email protected]> Reviewed-by: Michael Knyszek <[email protected]> Reviewed-by: Sameer Ajmani <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]>
golang · Nov 21, 2023 · 883aed5 · 883aed5
1 parent b24d3b5
commit 883aed5
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rate/rate.go b/rate/rate.go
@@ -52,6 +52,8 @@ func Every(interval time.Duration) Limit {
 // or its associated context.Context is canceled.
 //
 // The methods AllowN, ReserveN, and WaitN consume n tokens.
+//
+// Limiter is safe for simultaneous use by multiple goroutines.
 type Limiter struct {
 	mu     sync.Mutex
 	limit  Limit