time: document Tick will return nil if d <= 0

Fixes golang#14557. Change-Id: I9610b79aafe9c15f9c998739b586fd0b41b90d70 Reviewed-on: https://go-review.googlesource.com/20031 Reviewed-by: Brad Fitzpatrick <[email protected]>
ribrdb · Feb 29, 2016 · 28ce6f3 · 28ce6f3
1 parent 1b417e2
commit 28ce6f3
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/time/tick.go b/src/time/tick.go
@@ -50,6 +50,7 @@ func (t *Ticker) Stop() {
 // channel only. While Tick is useful for clients that have no need to shut down
 // the Ticker, be aware that without a way to shut it down the underlying
 // Ticker cannot be recovered by the garbage collector; it "leaks".
+// Unlike NewTicker, Tick will return nil if d <= 0.
 func Tick(d Duration) <-chan Time {
 	if d <= 0 {
 		return nil