realm-kotlin

realm-kotlin copied to clipboard

As the API develops we might want to ship features that are still under development. We should add a @Beta API similar to the one present in Realm Java.

Could we use the @OptIn annotation in Kotlin instead which would also give IDE support.

I don't think we should add a SDK-wide @Beta-annotation unless we see very good reasons for it. I would much rather do feature-based annotations that utilizes Kotlin's RequiresOptIn-mechanism. This will make it easier to track the state of the individual features and avoid opting in to unnecessary experimental features. It is only a matter of adding the RequiresOptIn to an annotation to get this behavior, so should be almost free.

After talking about it, we are going with the approach @rorbech outlined above. We will add annotations on a case-by-case basis. Closing this one.