Fix the broken [Option] link in metric docs (#4057)

The `Option` type was replaced with `InstrumentOption` when the `metric/instrument` package was moved to `metric`.
open-telemetry · May 8, 2023 · 476d00a · 476d00a
1 parent 07bf591
commit 476d00a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 17 deletions.
diff --git a/metric/asyncfloat64.go b/metric/asyncfloat64.go
@@ -83,8 +83,9 @@ func (c Float64ObservableCounterConfig) Callbacks() []Float64Callback {
 }
 
 // Float64ObservableCounterOption applies options to a
-// [Float64ObservableCounterConfig]. See [Float64ObservableOption] and [Option]
-// for other options that can be used as a Float64ObservableCounterOption.
+// [Float64ObservableCounterConfig]. See [Float64ObservableOption] and
+// [InstrumentOption] for other options that can be used as a
+// Float64ObservableCounterOption.
 type Float64ObservableCounterOption interface {
 	applyFloat64ObservableCounter(Float64ObservableCounterConfig) Float64ObservableCounterConfig
 }
@@ -141,7 +142,7 @@ func (c Float64ObservableUpDownCounterConfig) Callbacks() []Float64Callback {
 
 // Float64ObservableUpDownCounterOption applies options to a
 // [Float64ObservableUpDownCounterConfig]. See [Float64ObservableOption] and
-// [Option] for other options that can be used as a
+// [InstrumentOption] for other options that can be used as a
 // Float64ObservableUpDownCounterOption.
 type Float64ObservableUpDownCounterOption interface {
 	applyFloat64ObservableUpDownCounter(Float64ObservableUpDownCounterConfig) Float64ObservableUpDownCounterConfig
@@ -198,7 +199,7 @@ func (c Float64ObservableGaugeConfig) Callbacks() []Float64Callback {
 
 // Float64ObservableGaugeOption applies options to a
 // [Float64ObservableGaugeConfig]. See [Float64ObservableOption] and
-// [Option] for other options that can be used as a
+// [InstrumentOption] for other options that can be used as a
 // Float64ObservableGaugeOption.
 type Float64ObservableGaugeOption interface {
 	applyFloat64ObservableGauge(Float64ObservableGaugeConfig) Float64ObservableGaugeConfig

diff --git a/metric/asyncint64.go b/metric/asyncint64.go
@@ -82,8 +82,9 @@ func (c Int64ObservableCounterConfig) Callbacks() []Int64Callback {
 }
 
 // Int64ObservableCounterOption applies options to a
-// [Int64ObservableCounterConfig]. See [Int64ObservableOption] and [Option] for
-// other options that can be used as an Int64ObservableCounterOption.
+// [Int64ObservableCounterConfig]. See [Int64ObservableOption] and
+// [InstrumentOption] for other options that can be used as an
+// Int64ObservableCounterOption.
 type Int64ObservableCounterOption interface {
 	applyInt64ObservableCounter(Int64ObservableCounterConfig) Int64ObservableCounterConfig
 }
@@ -140,7 +141,7 @@ func (c Int64ObservableUpDownCounterConfig) Callbacks() []Int64Callback {
 
 // Int64ObservableUpDownCounterOption applies options to a
 // [Int64ObservableUpDownCounterConfig]. See [Int64ObservableOption] and
-// [Option] for other options that can be used as an
+// [InstrumentOption] for other options that can be used as an
 // Int64ObservableUpDownCounterOption.
 type Int64ObservableUpDownCounterOption interface {
 	applyInt64ObservableUpDownCounter(Int64ObservableUpDownCounterConfig) Int64ObservableUpDownCounterConfig
@@ -196,8 +197,9 @@ func (c Int64ObservableGaugeConfig) Callbacks() []Int64Callback {
 }
 
 // Int64ObservableGaugeOption applies options to a
-// [Int64ObservableGaugeConfig]. See [Int64ObservableOption] and [Option] for
-// other options that can be used as an Int64ObservableGaugeOption.
+// [Int64ObservableGaugeConfig]. See [Int64ObservableOption] and
+// [InstrumentOption] for other options that can be used as an
+// Int64ObservableGaugeOption.
 type Int64ObservableGaugeOption interface {
 	applyInt64ObservableGauge(Int64ObservableGaugeConfig) Int64ObservableGaugeConfig
 }

diff --git a/metric/syncfloat64.go b/metric/syncfloat64.go
@@ -63,7 +63,8 @@ func (c Float64CounterConfig) Unit() string {
 }
 
 // Float64CounterOption applies options to a [Float64CounterConfig]. See
-// [Option] for other options that can be used as a Float64CounterOption.
+// [InstrumentOption] for other options that can be used as a
+// Float64CounterOption.
 type Float64CounterOption interface {
 	applyFloat64Counter(Float64CounterConfig) Float64CounterConfig
 }
@@ -112,8 +113,8 @@ func (c Float64UpDownCounterConfig) Unit() string {
 }
 
 // Float64UpDownCounterOption applies options to a
-// [Float64UpDownCounterConfig]. See [Option] for other options that can be
-// used as a Float64UpDownCounterOption.
+// [Float64UpDownCounterConfig]. See [InstrumentOption] for other options that
+// can be used as a Float64UpDownCounterOption.
 type Float64UpDownCounterOption interface {
 	applyFloat64UpDownCounter(Float64UpDownCounterConfig) Float64UpDownCounterConfig
 }
@@ -162,7 +163,8 @@ func (c Float64HistogramConfig) Unit() string {
 }
 
 // Float64HistogramOption applies options to a [Float64HistogramConfig]. See
-// [Option] for other options that can be used as a Float64HistogramOption.
+// [InstrumentOption] for other options that can be used as a
+// Float64HistogramOption.
 type Float64HistogramOption interface {
 	applyFloat64Histogram(Float64HistogramConfig) Float64HistogramConfig
 }
diff --git a/metric/syncint64.go b/metric/syncint64.go
@@ -62,8 +62,9 @@ func (c Int64CounterConfig) Unit() string {
 	return c.unit
 }
 
-// Int64CounterOption applies options to a [Int64CounterConfig]. See [Option]
-// for other options that can be used as an Int64CounterOption.
+// Int64CounterOption applies options to a [Int64CounterConfig]. See
+// [InstrumentOption] for other options that can be used as an
+// Int64CounterOption.
 type Int64CounterOption interface {
 	applyInt64Counter(Int64CounterConfig) Int64CounterConfig
 }
@@ -112,7 +113,7 @@ func (c Int64UpDownCounterConfig) Unit() string {
 }
 
 // Int64UpDownCounterOption applies options to a [Int64UpDownCounterConfig].
-// See [Option] for other options that can be used as an
+// See [InstrumentOption] for other options that can be used as an
 // Int64UpDownCounterOption.
 type Int64UpDownCounterOption interface {
 	applyInt64UpDownCounter(Int64UpDownCounterConfig) Int64UpDownCounterConfig
@@ -162,7 +163,8 @@ func (c Int64HistogramConfig) Unit() string {
 }
 
 // Int64HistogramOption applies options to a [Int64HistogramConfig]. See
-// [Option] for other options that can be used as an Int64HistogramOption.
+// [InstrumentOption] for other options that can be used as an
+// Int64HistogramOption.
 type Int64HistogramOption interface {
 	applyInt64Histogram(Int64HistogramConfig) Int64HistogramConfig
 }