Purge remaining references to v0.10 from doc comments
Signed-off-by: beorn7 <bjoern@rabenste.in>
This commit is contained in:
parent
50c4339db7
commit
b5f69192ee
|
@ -53,7 +53,7 @@ func (u uncheckedCollector) Collect(c chan<- prometheus.Metric) {
|
||||||
func testHandler(t testing.TB) {
|
func testHandler(t testing.TB) {
|
||||||
// TODO(beorn7): This test is a bit too "end-to-end". It tests quite a
|
// TODO(beorn7): This test is a bit too "end-to-end". It tests quite a
|
||||||
// few moving parts that are not strongly coupled. They could/should be
|
// few moving parts that are not strongly coupled. They could/should be
|
||||||
// tested separately. However, the changes planned for v0.10 will
|
// tested separately. However, the changes planned for v2 will
|
||||||
// require a major rework of this test anyway, at which time I will
|
// require a major rework of this test anyway, at which time I will
|
||||||
// structure it in a better way.
|
// structure it in a better way.
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ const quantileLabel = "quantile"
|
||||||
// A typical use-case is the observation of request latencies. By default, a
|
// A typical use-case is the observation of request latencies. By default, a
|
||||||
// Summary provides the median, the 90th and the 99th percentile of the latency
|
// Summary provides the median, the 90th and the 99th percentile of the latency
|
||||||
// as rank estimations. However, the default behavior will change in the
|
// as rank estimations. However, the default behavior will change in the
|
||||||
// upcoming v0.10 of the library. There will be no rank estimations at all by
|
// upcoming v1.0.0 of the library. There will be no rank estimations at all by
|
||||||
// default. For a sane transition, it is recommended to set the desired rank
|
// default. For a sane transition, it is recommended to set the desired rank
|
||||||
// estimations explicitly.
|
// estimations explicitly.
|
||||||
//
|
//
|
||||||
|
@ -61,7 +61,7 @@ type Summary interface {
|
||||||
// DefObjectives are the default Summary quantile values.
|
// DefObjectives are the default Summary quantile values.
|
||||||
//
|
//
|
||||||
// Deprecated: DefObjectives will not be used as the default objectives in
|
// Deprecated: DefObjectives will not be used as the default objectives in
|
||||||
// v0.10 of the library. The default Summary will have no quantiles then.
|
// v1.0.0 of the library. The default Summary will have no quantiles then.
|
||||||
var (
|
var (
|
||||||
DefObjectives = map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001}
|
DefObjectives = map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001}
|
||||||
|
|
||||||
|
@ -86,7 +86,7 @@ const (
|
||||||
// mandatory to set Name to a non-empty string. While all other fields are
|
// mandatory to set Name to a non-empty string. While all other fields are
|
||||||
// optional and can safely be left at their zero value, it is recommended to set
|
// optional and can safely be left at their zero value, it is recommended to set
|
||||||
// a help string and to explicitly set the Objectives field to the desired value
|
// a help string and to explicitly set the Objectives field to the desired value
|
||||||
// as the default value will change in the upcoming v0.10 of the library.
|
// as the default value will change in the upcoming v1.0.0 of the library.
|
||||||
type SummaryOpts struct {
|
type SummaryOpts struct {
|
||||||
// Namespace, Subsystem, and Name are components of the fully-qualified
|
// Namespace, Subsystem, and Name are components of the fully-qualified
|
||||||
// name of the Summary (created by joining these components with
|
// name of the Summary (created by joining these components with
|
||||||
|
@ -128,7 +128,7 @@ type SummaryOpts struct {
|
||||||
// set it to an empty map (i.e. map[float64]float64{}).
|
// set it to an empty map (i.e. map[float64]float64{}).
|
||||||
//
|
//
|
||||||
// Note that the current value of DefObjectives is deprecated. It will
|
// Note that the current value of DefObjectives is deprecated. It will
|
||||||
// be replaced by an empty map in v0.10 of the library. Please
|
// be replaced by an empty map in v1.0.0 of the library. Please
|
||||||
// explicitly set Objectives to the desired value to avoid problems
|
// explicitly set Objectives to the desired value to avoid problems
|
||||||
// during the transition.
|
// during the transition.
|
||||||
Objectives map[float64]float64
|
Objectives map[float64]float64
|
||||||
|
|
Loading…
Reference in New Issue