Skip to content

Commit

Permalink
[chore] some doc changes to consumer package (#9150)
Browse files Browse the repository at this point in the history
small changes to some docs.
  • Loading branch information
atoulme authored Dec 20, 2023
1 parent 9f0c9e1 commit 44fbb84
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion consumer/consumer.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
// Capabilities describes the capabilities of a Processor.
type Capabilities struct {
// MutatesData is set to true if Consume* function of the
// processor modifies the input TraceData or MetricsData argument.
// processor modifies the input Traces, Logs or Metrics argument.
// Processors which modify the input data MUST set this flag to true. If the processor
// does not modify the data it MUST set this flag to false. If the processor creates
// a copy of the data before modifying then this flag can be safely set to false.
Expand Down
2 changes: 1 addition & 1 deletion consumer/doc.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

// Package consumer contains interfaces that receive and process consumerdata.
// Package consumer contains interfaces that receive and process data.
package consumer // import "go.opentelemetry.io/collector/consumer"
2 changes: 1 addition & 1 deletion consumer/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"go.opentelemetry.io/collector/pdata/pmetric"
)

// Metrics is the new metrics consumer interface that receives pmetric.Metrics, processes it
// Metrics is an interface that receives pmetric.Metrics, processes it
// as needed, and sends it to the next processing node if any or to the destination.
type Metrics interface {
baseConsumer
Expand Down

0 comments on commit 44fbb84

Please sign in to comment.