Explicit API mode? - Githubissues

Kotlin / kotlinx.collections.immutable

Immutable persistent collections for Kotlin

Apache License 2.0

1.12k stars 56 forks source link

Explicit API mode? #167

Closed Goooler closed 5 months ago

Goooler commented 6 months ago

I see some APIs under core/commonMain/src with the explicit modifiers and types but some of them are not, should we enable it by adding -Xexplicit-api=strict and check types strictly?

See https://github.com/Kotlin/KEEP/blob/master/proposals/explicit-api-mode.md

Goooler commented 6 months ago

Probably we can add Binary compatibility validator first.

qurbonzoda commented 5 months ago

Adding the both checks is quite important and will bring the library a step closer to the stable release. Could you please create a separate issue for adding binary compatibility validator?

Goooler commented 5 months ago

I'll add the validator tonight, so we don't need that issue explicitly?

qurbonzoda commented 5 months ago

An issue still has some benefits.

It will be a place to discuss and track the changes proposed in the associated pull request.
It can provide additional context, such as the rationale behind the changes, the problem being addressed, and any relevant information. This documentation becomes valuable for future reference and for understanding the context of the changes.
It helps in separating the process of identifying and discussing a problem or feature (issue) from the process of implementing the solution (pull request).
It can be referenced in release notes.

Goooler commented 5 months ago

It's in #168.