docs

Author: linkdata

README.md

@@ -13,6 +13,8 @@ Only depends on the standard library.
 
 `go get github.com/linkdata/bwlimit`
 
+`Ticker` must be created with `bwlimit.NewTicker()`. The zero-value `Ticker` is not supported.
+
 ## Example
 
 ```go

ticker.go

@@ -6,13 +6,15 @@ import (
 )
 
 // A Ticker synchronizes rate calculation among multiple Limiters.
+// Ticker values must be created with NewTicker; the zero value is not supported.
 type Ticker struct {
 	mu sync.Mutex
 	ch chan struct{}
 }
 
 var DefaultTicker *Ticker = NewTicker()
 
+// NewTicker creates and starts a Ticker.
 func NewTicker() (ot *Ticker) {
 	ot = &Ticker{ch: make(chan struct{})}
 	go ot.run()

ticker_test.go

@@ -6,8 +6,8 @@ import (
 	"time"
 )
 
-func TestTicker_zeroValue_NewLimiter(t *testing.T) {
-	l := (&Ticker{}).NewLimiter(1000)
+func TestTicker_NewTicker_NewLimiter(t *testing.T) {
+	l := NewTicker().NewLimiter(1000)
 	defer l.Stop()
 
 	done := make(chan struct{})
@@ -19,7 +19,6 @@ func TestTicker_zeroValue_NewLimiter(t *testing.T) {
 	select {
 	case <-done:
 	case <-time.After(time.Second):
-		t.Fatal("read stalled with zero-value ticker")
+		t.Fatal("read stalled with NewTicker")
 	}
 }
-