Document WithTimeout options for Query/QueryRange

Signed-off-by: Joseph Woodward <joseph.woodward@xeuse.com>
prometheus · Apr 26, 2022 · 2ce396b · 2ce396b
1 parent 4dcf02e
commit 2ce396b
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/api/prometheus/v1/api.go b/api/prometheus/v1/api.go
@@ -824,6 +824,7 @@ type apiOptions struct {
 
 type Option func(c *apiOptions)
 
+// WithTimeout can be used to provide an optional query evaluation timeout for Query and QueryRange.
 func WithTimeout(timeout time.Duration) Option {
 	return func(o *apiOptions) {
 		o.timeout = timeout