Add note that the option is advisory

open-telemetry · Oct 12, 2023 · 983a7c7 · 983a7c7
1 parent 67f421e
commit 983a7c7
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/metric/instrument.go b/metric/instrument.go
@@ -178,6 +178,8 @@ func (o unitOpt) applyInt64ObservableGauge(c Int64ObservableGaugeConfig) Int64Ob
 func WithUnit(u string) InstrumentOption { return unitOpt(u) }
 
 // WithExplicitBucketBoundaries sets the instrument explicit bucket boundaries.
+//
+// This option is considered "advisory", and may be ignored by API implementations.
 func WithExplicitBucketBoundaries(bounds ...float64) HistogramOption { return bucketOpt(bounds) }
 
 type bucketOpt []float64