Add docs for Kotlin First policy #1400
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1400 +/- ##
==========================================
- Coverage 63.16% 63.10% -0.07%
==========================================
Files 158 158
Lines 3125 3128 +3
Branches 324 324
==========================================
Hits 1974 1974
- Misses 1056 1059 +3
Partials 95 95 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
docs/KOTLIN_FIRST.md
Outdated
|
|
||
| Despite this policy, the Agent API should still be usable from Java, but they will not be optimized for it. For instance, a method that uses default arguments in Kotlin will require Java users to pass them in explicitly if no reasonable overloads can be provided. | ||
|
|
||
| As the API evolves, we will endeavor to preserve Java compile and runtime compatibility as much as possible. But we will only consider a change "breaking" if it affects the Kotlin use-case. As such, we advise that all calls to the Agent API are made from Kotlin if possible to prevent syntactic changes from breaking your app's build. |
There was a problem hiding this comment.
So I'd like to see this changed so that we explain that we do NOT make any efforts to preserve Java compatibility, and the Java use case is "unsupported" -- which means that issues should not be filed and we will not accept PRs to address Java language compatibility issues at the API or configuration layers.
There was a problem hiding this comment.
Even stronger stance. OK! I take @LikeTheSalad's thumbs up on his agreement.
There was a problem hiding this comment.
Thanks @bidetofevil, this helps! I had a few small comments.
Also, can you please add hard line breaks in the markdown? It makes it easier to review and add suggestions without having to suggest the whole darn paragraph. 🙏🏻 We should have a markdown linter one day that helps with this (other projects have it), but alas we do not yet.
Co-authored-by: jason plumb <[email protected]>
I was hoping spotless would do this for me. Alas.... |
3 participants
Add some documentation about the project's policy of being Kotlin First