runtime/metrics: clarify Read's documentation

Change-Id: Idbcbc304f1568399a82af9dcd51e511393ed5ee0 Reviewed-on: https://go-review.googlesource.com/c/go/+/271558 Run-TryBot: Michael Knyszek <[email protected]> TryBot-Result: Go Bot <[email protected]> Trust: Michael Knyszek <[email protected]> Reviewed-by: Michael Pratt <[email protected]>
threestoneliu · Nov 19, 2020 · 59f5fda · 59f5fda
1 parent add4593
commit 59f5fda
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/runtime/metrics/sample.go b/src/runtime/metrics/sample.go
@@ -27,11 +27,11 @@ func runtime_readMetrics(unsafe.Pointer, int, int)
 // 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.
+// The user of this API is encouraged to re-use the same slice between calls for
+// efficiency, but is not required to do so.
 //
-// Metric values with names not appearing in the value returned by Descriptions
-// will have the value populated as KindBad to indicate that the name is
-// unknown.
+// 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))
 }