time: document that time.Tick creates an unrecoverable resource

Fixes #11662.

Change-Id: I8839b48a1cd3da4c29b6def03cb0c74c1c12942e
Reviewed-on: https://go-review.googlesource.com/12066
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>

diff --git a/src/time/tick.go b/src/time/tick.go
index 19007841e1af045821168cbde5faf6322dfda6ad..196e8ac61a6da384f6f12ace65f05a921e264ed1 100644 (file)
--- a/src/time/tick.go
+++ b/src/time/tick.go
@@ -47,7 +47,9 @@ func (t *Ticker) Stop() {
 }
 
 // Tick is a convenience wrapper for NewTicker providing access to the ticking
-// channel only.  Useful for clients that have no need to shut down the ticker.
+// 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".
 func Tick(d Duration) <-chan Time {
        if d <= 0 {
                return nil