Merge pull request #152 from realzeitmedia/document-objectives

More explicit documentation of SummaryOpts.Objectives.
This commit is contained in:
Björn Rabenstein 2015-08-03 14:47:03 +02:00
commit 029ed626e6
1 changed files with 3 additions and 1 deletions

View File

@ -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 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
// MaxAge defines the duration for which an observation stays relevant