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.

Sign up for GitHub

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

Jump to bottom

Consider hiding implementation elements #1640

Closed
carlosalberto opened this issue Feb 25, 2021 · 1 comment · Fixed by #1684
Closed

Consider hiding implementation elements #1640

carlosalberto opened this issue Feb 25, 2021 · 1 comment · Fixed by #1684
Assignees
@lzchen
Labels
1.0.0rc2 release candidate 2 for tracing GA

Comments

@carlosalberto
Copy link
Contributor

carlosalberto commented Feb 25, 2021 •
edited
Loading

Consider hiding implementation specific elements, or else consider hiding them when producing the documentation (unless they are needed outside the API/SDK, that is). A few members like that are:

  • LinkBase
  • Tracer.CURRENT_SPAN
  • DefaultTracerProvider
  • RuntimeContext
  • BagagePropagator.MAX_* fields
  • SDK's EventBase
  • ResourceDetector
@lzchen lzchen added the 1.0.0rc2 release candidate 2 for tracing GA label Feb 25, 2021
@codeboten
Copy link
Contributor

We should make these implementation details protected.

@lzchen lzchen mentioned this issue Mar 9, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lzchen lzchen

Labels
1.0.0rc2 release candidate 2 for tracing GA
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Hide certain implementation specific classes/variables lzchen/opentelemetry-python
3 participants
@codeboten @carlosalberto @lzchen