Merge pull request #213 from stapelberg/patch-1

fabxc · web-flow · commit 52437c81da6b · 2016-08-02T00:22:46.000-07:00
api: document goroutine safeness
diff --git a/api/prometheus/api.go b/api/prometheus/api.go
@@ -102,6 +102,8 @@ type Client interface {
 }
 
 // New returns a new Client.
+//
+// It is safe to use the returned Client from multiple goroutines.
 func New(cfg Config) (Client, error) {
 	u, err := url.Parse(cfg.Address)
 	if err != nil {
@@ -280,6 +282,8 @@ type QueryAPI interface {
 }
 
 // NewQueryAPI returns a new QueryAPI for the client.
+//
+// It is safe to use the returned QueryAPI from multiple goroutines.
 func NewQueryAPI(c Client) QueryAPI {
 	return &httpQueryAPI{client: apiClient{c}}
 }

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,8 @@ type Client interface {`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`// New returns a new Client.`
	`105`	`+//`
	`106`	`+// It is safe to use the returned Client from multiple goroutines.`
`105`	`107`	`func New(cfg Config) (Client, error) {`
`106`	`108`	`u, err := url.Parse(cfg.Address)`
`107`	`109`	`if err != nil {`
`@@ -280,6 +282,8 @@ type QueryAPI interface {`
`280`	`282`	`}`
`281`	`283`
`282`	`284`	`// NewQueryAPI returns a new QueryAPI for the client.`
	`285`	`+//`
	`286`	`+// It is safe to use the returned QueryAPI from multiple goroutines.`
`283`	`287`	`func NewQueryAPI(c Client) QueryAPI {`
`284`	`288`	`return &httpQueryAPI{client: apiClient{c}}`
`285`	`289`	`}`