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

Hide unintentionally public API #211

Open
qurbonzoda opened this issue May 10, 2024 · 2 comments
Open

Hide unintentionally public API #211

qurbonzoda opened this issue May 10, 2024 · 2 comments

Comments

@qurbonzoda
Copy link
Collaborator

Both the :plugin and :runtime modules have many APIs that were accidentally introduced with a public visibility modifier. These APIs are currently annotated with @KotlinxBenchmarkPluginInternalApi and @KotlinxBenchmarkRuntimeInternalApi in the plugin and runtime, respectively.

The annotations require opt-in with a WARNING level. This level should be advanced to ERROR in a future release, and eventually, the annotated APIs should become internal, ceasing to be part of the library's public API.

Once the APIs are made internal, make sure to drop those that are not used internally.

@lppedd
Copy link

lppedd commented May 10, 2024

Are you sure the double step is necessary? Given the alpha status I'd not even bother with deprecations and make them internal now. I don't think there are many people using those APIs anyway.

@qurbonzoda
Copy link
Collaborator Author

I also believe that not many people use those APIs, if at all. However, I would like to make the migration smoother just in case. The deprecation cycle will be short, unlike in stable libraries.

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

2 participants