Skip to content

Commit 1bae6c1

Browse files
authored
Deprecated comment should begin with "Deprecated:" (#1347)
See https://go.dev/blog/godoc Signed-off-by: Oleksandr Redko <Oleksandr_Redko@epam.com>
1 parent bbab8fe commit 1bae6c1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Diff for: prometheus/collectors/go_collector_latest.go

+6-3
Original file line numberDiff line numberDiff line change
@@ -132,16 +132,19 @@ type GoCollectionOption uint32
132132

133133
const (
134134
// GoRuntimeMemStatsCollection represents the metrics represented by runtime.MemStats structure.
135-
// Deprecated. Use WithGoCollectorMemStatsMetricsDisabled() function to disable those metrics in the collector.
135+
//
136+
// Deprecated: Use WithGoCollectorMemStatsMetricsDisabled() function to disable those metrics in the collector.
136137
GoRuntimeMemStatsCollection GoCollectionOption = 1 << iota
137138
// GoRuntimeMetricsCollection is the new set of metrics represented by runtime/metrics package.
138-
// Deprecated. Use WithGoCollectorRuntimeMetrics(GoRuntimeMetricsRule{Matcher: regexp.MustCompile("/.*")})
139+
//
140+
// Deprecated: Use WithGoCollectorRuntimeMetrics(GoRuntimeMetricsRule{Matcher: regexp.MustCompile("/.*")})
139141
// function to enable those metrics in the collector.
140142
GoRuntimeMetricsCollection
141143
)
142144

143145
// WithGoCollections allows enabling different collections for Go collector on top of base metrics.
144-
// Deprecated. Use WithGoCollectorRuntimeMetrics() and WithGoCollectorMemStatsMetricsDisabled() instead to control metrics.
146+
//
147+
// Deprecated: Use WithGoCollectorRuntimeMetrics() and WithGoCollectorMemStatsMetricsDisabled() instead to control metrics.
145148
func WithGoCollections(flags GoCollectionOption) func(options *internal.GoCollectorOptions) {
146149
return func(options *internal.GoCollectorOptions) {
147150
if flags&GoRuntimeMemStatsCollection == 0 {

0 commit comments

Comments
 (0)