[Docs] Mark new kotlin.time types as new in 2.1.20 #5434
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The KotlinLang Docs for e.g. [`Instant`](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.time/-instant/) specify that Instant is available since Kotlin 2.1. However, it is only available from 2.1.20. The same applies for `Clock`. When attempting to use these types in a Kotlin 2.1.10 project, I was left confused at the inability to import them. I eventually found the reason in the Kotlin 2.1.20 release changelog. SinceKotlin's version field supports patch-level versions: > `@property version The version in the following formats: `<major>.<minor>` > or `<major>.<minor>.<patch>`, where major, minor and patch > are non-negative integer numbers without leading zeros. This PR includes the patch version for the Instant, Clock, and the relevant Instant top-level functions.
|
Note that this change affects not only generated docs, but also how the compiler filters out available declarations depending on the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The KotlinLang Docs for e.g.
Instantspecify that Instant is available since Kotlin 2.1. However, it is only available from 2.1.20. The same applies forClock.When attempting to use these types in a Kotlin 2.1.10 project, I was left confused at the inability to import them. I eventually found the reason in the Kotlin 2.1.20 release changelog.
SinceKotlin's version field supports patch-level versions:
This PR includes the patch version for the Instant, Clock, and the relevant Instant top-level functions.