]> Cypherpunks.ru repositories - gostls13.git/commit
runtime/metrics: add ordering line to supported metrics docs
authorMichael Anthony Knyszek <mknyszek@google.com>
Fri, 4 Dec 2020 16:04:53 +0000 (16:04 +0000)
committerMichael Knyszek <mknyszek@google.com>
Thu, 10 Dec 2020 21:08:10 +0000 (21:08 +0000)
commitd0f40d29223a2aef58475f81a559b2d27396134a
treea3eeaa313ab5d8addb966b9d6f5af011cb5e5aa5
parent6d2b3351f6312ebc924d0014013088c69b9c1bc2
runtime/metrics: add ordering line to supported metrics docs

This change adds an additional line explaining the ordering of the
supported metrics list. It's also necessary to ensure "Supported
metrics" is displayed by godoc as a proper header.

This modification does mean the description test, that ensures
descriptions line up with documentation, needs to change slightly
so it it doesn't read this new line as documentation. Make this
new line the line the test uses to decide when to begin.

Change-Id: I654c1c20e97a80ea79c8eb864445153ce91950bf
Reviewed-on: https://go-review.googlesource.com/c/go/+/275852
Run-TryBot: Michael Knyszek <mknyszek@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Trust: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Michael Pratt <mpratt@google.com>
src/runtime/metrics/description_test.go
src/runtime/metrics/doc.go