Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review and improve config package #3051

Closed
bogdandrutu opened this issue Apr 28, 2021 · 1 comment
Closed

Review and improve config package #3051

bogdandrutu opened this issue Apr 28, 2021 · 1 comment
Assignees
Labels
area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release

Comments

@bogdandrutu
Copy link
Member

bogdandrutu commented Apr 28, 2021

This is an umbrella issue for feedback and improvements for the config package.

Godoc: https://pkg.go.dev/go.opentelemetry.io/[email protected]/config

Things that we should look for:

  1. Can we avoid exposing publicly some of the APIs? Better to have less public APIs.
  2. Can we improve the names of the public APIs?
  3. Can we improve the documentation of the package/public APIs?
@bogdandrutu bogdandrutu added this to the Phase1-GA-Roadmap milestone Apr 28, 2021
@alolita
Copy link
Member

alolita commented May 12, 2021

@bogdandrutu can this be closed? The docs look good for the config package - see https://pkg.go.dev/go.opentelemetry.io/[email protected]/config

@alolita alolita added area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release labels May 18, 2021
tigrannajaryan pushed a commit that referenced this issue Jun 8, 2021
This PR is one of the 3 PRs working to address the issue: Reviewing and Improving config package.
Main changes that were made in this PR was to ensure types and function names with `grpc` is consistent throughout. For exported functions and types, changes were made such that `GRPC` is used. As for unexported functions and types, `gRPC` is now used.

Addresses part of #3051
@alolita alolita closed this as completed Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation priority:p2 Medium release:required-for-ga Must be resolved before GA release
Projects
None yet
Development

No branches or pull requests

3 participants