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

Update javadoc boilerplate for experimental classes which are for public use #6662

Open
jack-berg opened this issue Aug 21, 2024 · 0 comments

Comments

@jack-berg
Copy link
Member

jack-berg commented Aug 21, 2024

We have standard boiler plate for internal classes which are public which reads:

 * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
 * at any time.

But I wonder if we should adjust our boilerplate for these types of methods - internal because we make no compatibility guarantees, but acceptable for public consumption provided the user accepts the risks of breaking changes.

Maybe something like:

This class is internal and experimental. Its APIs are unstable and can change at any time. Its APIs (or a version of them) may be promoted to the public stable API in the future, but no guarantees are made.

Places this updated message would be relevant:

  • SdkTracerProviderUtil
  • SdkMeterProviderUtil
  • MeterConfig, TracerConfig, LoggerConfig
  • SdkEventLoggerProvider
  • ... and more

Originally posted by @jack-berg in #6367 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant