Skip to content

Commit

Permalink
Revise and edit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAlias committed Aug 2, 2022
1 parent e2926a0 commit 54a3e24
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
10 changes: 5 additions & 5 deletions exporters/stdout/stdoutmetric/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
// Package stdoutmetric provides an exporter for OpenTelemetry metric
// telemetry.
//
// The exporter is intended to be used for testing and debugging. It is not an
// exporter meant for production use. Additionally, it does not provide an
// interchange format for OpenTelemetry that is supported with any stability
// or compatibility guarantees. If these are needed features, please use the
// OTLP exporter instead.
// The exporter is intended to be used for testing and debugging, it is not
// meant for production use. Additionally, it does not provide an interchange
// format for OpenTelemetry that is supported with any stability or
// compatibility guarantees. If these are needed features, please use the OTLP
// exporter instead.
package stdoutmetric // import "go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
3 changes: 1 addition & 2 deletions exporters/stdout/stdoutmetric/encoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ import "errors"
// Encoder encodes and outputs OpenTelemetry metric data-types as human
// readable text.
type Encoder interface {
// Encode handles the encoding and writing OpenTelemetry metric data-types
// that the exporter will pass to it.
// Encode handles the encoding and writing of OpenTelemetry metric data.
Encode(v any) error
}

Expand Down
4 changes: 2 additions & 2 deletions exporters/stdout/stdoutmetric/exporter.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ type exporter struct {
shutdownOnce sync.Once
}

// New returns a configured metric Exporter.
// New returns a configured metric exporter.
//
// If no options are passed, the default exporter returned will use a JSON
// encoder with tab indentations.
// encoder with tab indentations that output to STDOUT.
func New(options ...Option) (metric.Exporter, error) {
cfg := newConfig(options...)
exp := &exporter{}
Expand Down

0 comments on commit 54a3e24

Please sign in to comment.