From 5b1aa4ab69879a6d422ccda99b7349bf0fcb4495 Mon Sep 17 00:00:00 2001 From: Robert Vollmert Date: Mon, 3 Aug 2015 13:49:15 +0200 Subject: [PATCH] More explicit documentation of SummaryOpts.Objectives. --- prometheus/summary.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/prometheus/summary.go b/prometheus/summary.go index 67fe43c..e22246c 100644 --- a/prometheus/summary.go +++ b/prometheus/summary.go @@ -112,7 +112,9 @@ type SummaryOpts struct { ConstLabels Labels // Objectives defines the quantile rank estimates with their respective - // absolute error. The default value is DefObjectives. + // absolute error. If Objectives[q] = e, then the reported q-quantile + // value will be the r-quantile value with r between q-e and q+e. + // The default value is DefObjectives. Objectives map[float64]float64 // MaxAge defines the duration for which an observation stays relevant