Skip to content

Edit type/func documentation in the consumer package#3269

Merged
bogdandrutu merged 31 commits intoopen-telemetry:mainfrom
open-o11y:edit-godocs-consumer
Jun 14, 2021
Merged

Edit type/func documentation in the consumer package#3269
bogdandrutu merged 31 commits intoopen-telemetry:mainfrom
open-o11y:edit-godocs-consumer

Conversation

@eddyleelin
Copy link
Copy Markdown
Contributor

@eddyleelin eddyleelin commented May 24, 2021

Description:
This PR updates the documentation of type and func declarations in the consumer package and all of its subpackages, with a focus on correcting grammar/spelling mistakes, cleaning up syntax to render the examples better, and updating incorrect references or wording. Note that this does not

Link to tracking Issue:
Addresses part of issue #3050.
Related to #3361

Documentation:

  • Add number of upstream PR.

@eddyleelin eddyleelin requested a review from a team May 24, 2021 14:30
Changing here will ensure that the changes to consumer/pdata/generated_* files will persist after running `go run cmd/pdatagen/main.go`.
@bogdandrutu
Copy link
Copy Markdown
Member

Tests failed:

make build-binary-internal
make[1]: Entering directory '/home/circleci/project'
GO111MODULE=on CGO_ENABLED=0 go build -trimpath -o ./bin/otelcol_linux_amd64 -ldflags "-X go.opentelemetry.io/collector/internal/version.Version=v0.27.0-33-g84329591" ./cmd/otelcol
# go.opentelemetry.io/collector/consumer/pdata
consumer/pdata/generated_log.go:21:2: imported and not used: "go.opentelemetry.io/collector/internal/data/protogen/common/v1" as otlpcommon
consumer/pdata/generated_trace.go:21:2: imported and not used: "go.opentelemetry.io/collector/internal/data"
consumer/pdata/generated_trace.go:22:2: imported and not used: "go.opentelemetry.io/collector/internal/data/protogen/common/v1" as otlpcommon
make[1]: *** [Makefile:252: build-binary-internal] Error 2
make[1]: Leaving directory '/home/circleci/project'
make: *** [Makefile:163: otelcol] Error 2

Copy link
Copy Markdown
Member

@bogdandrutu bogdandrutu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please for me split this into 2 PRs:

  1. cmd/pdatagen and consumer/pdata
  2. Rest of the files

This will help me a lot for review.

@eddyleelin
Copy link
Copy Markdown
Contributor Author

Thanks @bogdandrutu for the suggestion; I have updated this PR to not contain any of the cmd/pdatagen/internal or consumer/pdata/generated*.go files! Those files will be handled in the PR #3361 . Thanks again 😄

// Metrics is an opaque interface that allows transition to the new internal Metrics data, but also facilitate the
// transition to the new components especially for traces.
// Metrics is an opaque interface that allows transition to the new internal Metrics data, but also facilitates the
// transition to the new components, especially for traces.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reference to "traces" is confusing here. @bogdandrutu do you know what this is supposed to mean?

@tigrannajaryan
Copy link
Copy Markdown
Member

Please resolve the conflicts.

eddyleelin and others added 3 commits June 12, 2021 14:51
For func defined in consumer/consumertest/err.go

Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Renamed "message" to "string"
@alolita
Copy link
Copy Markdown
Member

alolita commented Jun 14, 2021

@bogdandrutu can you please review and this PR can then be merged if all is done.

@alolita alolita added the ready-to-merge Code review completed; ready to merge by maintainers label Jun 14, 2021
@bogdandrutu bogdandrutu merged commit 1fada74 into open-telemetry:main Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Code review completed; ready to merge by maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants