From 6a1bbca2b3129b18f7d7e63b51536da2e9afe9e2 Mon Sep 17 00:00:00 2001 From: cui fliter Date: Tue, 7 Nov 2023 17:35:46 +0800 Subject: runtime: add available godoc link Change-Id: Ifb4844efddcb0369b0302eeab72394eeaf5c8072 Reviewed-on: https://go-review.googlesource.com/c/go/+/540022 Reviewed-by: Michael Knyszek Auto-Submit: Michael Knyszek Reviewed-by: Heschi Kreinick TryBot-Result: Gopher Robot Run-TryBot: shuang cui LUCI-TryBot-Result: Go LUCI --- src/runtime/metrics/sample.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/runtime/metrics/sample.go') diff --git a/src/runtime/metrics/sample.go b/src/runtime/metrics/sample.go index 4cf8cdf799..9efc5c5f06 100644 --- a/src/runtime/metrics/sample.go +++ b/src/runtime/metrics/sample.go @@ -24,7 +24,7 @@ type Sample struct { // Implemented in the runtime. func runtime_readMetrics(unsafe.Pointer, int, int) -// Read populates each Value field in the given slice of metric samples. +// Read populates each [Value] field in the given slice of metric samples. // // Desired metrics should be present in the slice with the appropriate name. // The user of this API is encouraged to re-use the same slice between calls for @@ -32,7 +32,7 @@ func runtime_readMetrics(unsafe.Pointer, int, int) // // Note that re-use has some caveats. Notably, Values should not be read or // manipulated while a Read with that value is outstanding; that is a data race. -// This property includes pointer-typed Values (for example, Float64Histogram) +// This property includes pointer-typed Values (for example, [Float64Histogram]) // whose underlying storage will be reused by Read when possible. To safely use // such values in a concurrent setting, all data must be deep-copied. // @@ -40,7 +40,7 @@ func runtime_readMetrics(unsafe.Pointer, int, int) // must share no underlying memory. When in doubt, create a new []Sample from // scratch, which is always safe, though may be inefficient. // -// Sample values with names not appearing in All will have their Value populated +// Sample values with names not appearing in [All] will have their Value populated // as KindBad to indicate that the name is unknown. func Read(m []Sample) { runtime_readMetrics(unsafe.Pointer(&m[0]), len(m), cap(m)) -- cgit v1.3