docs: add warning about StopTimer()

ipfs · Mar 3, 2020 · 7205ffa · 7205ffa
1 parent 314ac7d
commit 7205ffa
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/internal/timer/timer.go b/internal/timer/timer.go
@@ -4,6 +4,9 @@ import (
 	"time"
 )
 
+// Stop the timer and drain the channel.
+// Note that this should only be called if the channel hasn't already been
+// drained or it may block indefinitely.
 func StopTimer(t *time.Timer) {
 	if !t.Stop() {
 		// Need to drain the timer if Stop() returns false