Skip to content

Commit 9b7e3c3

Browse files
authored
Merge pull request #769 from modelix/docs/clarify-intended-finalization
docs: clarify intendedFinalization in UnstableModelixFeature
2 parents 24f5b0e + 8b5ab24 commit 9b7e3c3

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

kotlin-utils/src/commonMain/kotlin/org/modelix/kotlin/utils/UnstableModelixFeature.kt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ package org.modelix.kotlin.utils
2020
* Marks an API as unstable.
2121
*
2222
* @param reason Describes why the feature is experimental.
23-
* @param intendedFinalization Describes when this API is intended to be finalized or removed.
23+
* @param intendedFinalization Describes when this API is intended to be
24+
* finalized or removed. This field is intended to capture a condition and
25+
* progress metadata such as a ticket number describing when the feature
26+
* becomes ready. It's not meant to capture a date or specific release.
2427
*/
2528
@RequiresOptIn(message = "This API is experimental. It may be changed in the future without notice.")
2629
@Retention(AnnotationRetention.BINARY)

0 commit comments

Comments
 (0)