Skip to content

Commit 2184a39

Browse files
dolmengopherbot
authored andcommitted
runtime/metrics: godoc link fixes
Fix rendering of link to runtime/debug.ReadGCStats in package overview: as the package is not imported we must specify the absolute package name. Change-Id: I123db49eee05e6812427e19873e628b4e4feb203 Reviewed-on: https://go-review.googlesource.com/c/go/+/549735 Reviewed-by: Than McIntosh <[email protected]> Reviewed-by: Daniel Martí <[email protected]> Auto-Submit: Michael Knyszek <[email protected]> TryBot-Result: Gopher Robot <[email protected]> Reviewed-by: Michael Knyszek <[email protected]> Run-TryBot: qiulaidongfeng <[email protected]> Reviewed-by: qiulaidongfeng <[email protected]>
1 parent 9c01ecc commit 2184a39

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/runtime/metrics/doc.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/*
99
Package metrics provides a stable interface to access implementation-defined
1010
metrics exported by the Go runtime. This package is similar to existing functions
11-
like [runtime.ReadMemStats] and [debug.ReadGCStats], but significantly more general.
11+
like [runtime.ReadMemStats] and [runtime/debug.ReadGCStats], but significantly more general.
1212
1313
The set of metrics defined by this package may evolve as the runtime itself
1414
evolves, and also enables variation across Go implementations, whose relevant
@@ -28,7 +28,8 @@ encouraged to use build tags, and although metrics may be deprecated and removed
2828
users should consider this to be an exceptional and rare event, coinciding with a
2929
very large change in a particular Go implementation.
3030
31-
Each metric key also has a "kind" that describes the format of the metric's value.
31+
Each metric key also has a "kind" (see [ValueKind]) that describes the format of the
32+
metric's value.
3233
In the interest of not breaking users of this package, the "kind" for a given metric
3334
is guaranteed not to change. If it must change, then a new metric will be introduced
3435
with a new key and a new "kind."

0 commit comments

Comments
 (0)