Minor doc comment fix

This was forgotten to be included in the previous commit.
This commit is contained in:
beorn7 2018-01-11 16:59:30 +01:00
parent 180b8fdc22
commit f02bfc3484
1 changed files with 9 additions and 9 deletions

View File

@ -68,15 +68,15 @@ func InstrumentRoundTripperCounter(counter *prometheus.CounterVec, next http.Rou
} }
// InstrumentRoundTripperDuration is a middleware that wraps the provided // InstrumentRoundTripperDuration is a middleware that wraps the provided
// http.RoundTripper to observe the request duration with the provided ObserverVec. // http.RoundTripper to observe the request duration with the provided
// The ObserverVec must have zero, one, or two labels. The only allowed label // ObserverVec. The ObserverVec must have zero, one, or two non-const
// names are "code" and "method". The function panics if any other instance // non-curried labels. For those, the only allowed label names are "code" and
// labels are provided. The Observe method of the Observer in the ObserverVec // "method". The function panics otherwise. The Observe method of the Observer
// is called with the request duration in seconds. Partitioning happens by HTTP // in the ObserverVec is called with the request duration in
// status code and/or HTTP method if the respective instance label names are // seconds. Partitioning happens by HTTP status code and/or HTTP method if the
// present in the ObserverVec. For unpartitioned observations, use an // respective instance label names are present in the ObserverVec. For
// ObserverVec with zero labels. Note that partitioning of Histograms is // unpartitioned observations, use an ObserverVec with zero labels. Note that
// expensive and should be used judiciously. // partitioning of Histograms is expensive and should be used judiciously.
// //
// If the wrapped RoundTripper panics or returns a non-nil error, no values are // If the wrapped RoundTripper panics or returns a non-nil error, no values are
// reported. // reported.