doc(Add): Clarify side-effects are best-effort

uber-go · Sep 8, 2023 · 8b81867 · 8b81867
1 parent 81e16be
commit 8b81867
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/internal/ztest/clock.go b/internal/ztest/clock.go
@@ -89,10 +89,13 @@ func (c *MockClock) NewTicker(d time.Duration) *time.Ticker {
 }
 
 // Add progresses time by the given duration.
-//
 // Other operations waiting for the time to advance
 // will be resolved if they are within range.
 //
+// Side effects of operations waiting for the time to advance
+// will take effect on a best-effort basis.
+// Avoid racing with operations that have side effects.
+//
 // Panics if the duration is negative.
 func (c *MockClock) Add(d time.Duration) {
 	if d < 0 {