Merge pull request #152 from realzeitmedia/document-objectives
More explicit documentation of SummaryOpts.Objectives.
This commit is contained in:
commit
029ed626e6
|
@ -112,7 +112,9 @@ type SummaryOpts struct {
|
||||||
ConstLabels Labels
|
ConstLabels Labels
|
||||||
|
|
||||||
// Objectives defines the quantile rank estimates with their respective
|
// Objectives defines the quantile rank estimates with their respective
|
||||||
// absolute error. The default value is DefObjectives.
|
// absolute error. If Objectives[q] = e, then the value reported
|
||||||
|
// for q will be the φ-quantile value for some φ between q-e and q+e.
|
||||||
|
// The default value is DefObjectives.
|
||||||
Objectives map[float64]float64
|
Objectives map[float64]float64
|
||||||
|
|
||||||
// MaxAge defines the duration for which an observation stays relevant
|
// MaxAge defines the duration for which an observation stays relevant
|
||||||
|
|
Loading…
Reference in New Issue