-
Notifications
You must be signed in to change notification settings - Fork 736
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
Remove @Deprecated from @Preview and @BetaApi methods and classes #1003
Comments
You hit the nail on the head. I was experimenting with a couple of options locally. We can take a route similar to what guava does with their Another option is we could provide an arch rule in either documentation examples or published artifacts. Then users would be able to either implement the test based on the example. If we publish a set of rules for users to consume, whether it is via annotation processor, checker plugin, or arch test, it would at least allow us to update recommended checks as new features are implemented and the sdk is iterated on. Thoughts? |
Side note, moving in this direction would also allow us to expose configuration options to users so that they may restrict preview usage in their codebase to only a subset of preview APIs. |
@marcoferrer |
The
@Deprecated
annotation on@Preview
and@BetaApi
methods and class results quite a bit of confusion. People assume these methods are actually deprecated and going away, when they are not. Further, there are a growing number of actually deprecated methods in this library this will eventually go away. We should find a better way to inform users that methods are in preview or beta.@marcoferrer
From your work on #1001 and #1002, perhaps you'd have input here.
Can we use ArchUnit to check that methods with those annotations have some specific text in their JavaDoc titles, for example "(BETA)" or "(PREVIEW)"? Or perhaps we could write a checkstyle rule?
The text was updated successfully, but these errors were encountered: