]> Cypherpunks repositories - gostls13.git/commitdiff
runtime/metrics: fix a couple of documentation typpos
authorIan Lance Taylor <iant@golang.org>
Sun, 7 Feb 2021 23:25:39 +0000 (15:25 -0800)
committerIan Lance Taylor <iant@golang.org>
Tue, 9 Feb 2021 02:00:01 +0000 (02:00 +0000)
Fixes #44150

Change-Id: Ibe5bfba01491dd8c2f0696fab40a1673230d76e9
Reviewed-on: https://go-review.googlesource.com/c/go/+/290349
Trust: Ian Lance Taylor <iant@golang.org>
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
src/runtime/metrics/doc.go
src/runtime/metrics/sample.go
src/runtime/metrics/value.go

index 021a0bddcaf3527b85a60a6e35bd807ad33f6c5e..5da050f973bd0569b7d58792319b6baca55d704c 100644 (file)
@@ -16,13 +16,14 @@ Interface
 Metrics are designated by a string key, rather than, for example, a field name in
 a struct. The full list of supported metrics is always available in the slice of
 Descriptions returned by All. Each Description also includes useful information
-about the metric, such as how to display it (e.g. gauge vs. counter) and how difficult
-or disruptive it is to obtain it (e.g. do you need to stop the world?).
+about the metric, such as how to display it (for example, gauge vs. counter)
+and how difficult or disruptive it is to obtain it (for example, do you need to
+stop the world?).
 
 Thus, users of this API are encouraged to sample supported metrics defined by the
 slice returned by All to remain compatible across Go versions. Of course, situations
 arise where reading specific metrics is critical. For these cases, users are
-encouranged to use build tags, and although metrics may be deprecated and removed,
+encouraged to use build tags, and although metrics may be deprecated and removed,
 users should consider this to be an exceptional and rare event, coinciding with a
 very large change in a particular Go implementation.
 
index 35534dd70da50f6cf05cc21845f24e781e8dd1ad..b3933e266ed254a95ca2c4a2781ec07976fb2e45 100644 (file)
@@ -32,9 +32,9 @@ 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 (e.g. 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.
+// 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.
 //
 // It is safe to execute multiple Read calls concurrently, but their arguments
 // must share no underlying memory. When in doubt, create a new []Sample from
index 61e8a192a30d424b6cf57ddd58e73b769f073c2e..ed9a33d87cc64e126f68f165e20411aa7cd7a813 100644 (file)
@@ -33,7 +33,7 @@ type Value struct {
        pointer unsafe.Pointer // contains non-scalar values.
 }
 
-// Kind returns the tag representing the kind of value this is.
+// Kind returns the tag representing the kind of value this is.
 func (v Value) Kind() ValueKind {
        return v.kind
 }