cashapp / misk

Microservice Kontainer
https://cashapp.github.io/misk/
Apache License 2.0
399 stars 169 forks source link

Add @ExperimentalMiskApi #3272

Closed ean5533 closed 4 months ago

ean5533 commented 4 months ago

Shamelessly cribbed from ExperimentalOkHttpApi, this new annotation will allow us to better communicate the unstable nature of new public classes and methods. This will allow us to more rapidly iterate on these features without worrying as much about breaking changes, which is good both for code authors and reviewers. It's also good for Misk users who will have a clearer signal about what is and isn't safe to start using.

This PR also demonstrates usage of the annotation by applying it to TaggedLogger, a class which was created recently and is being iterated on right now.