New ExperimentalCollectionApi annotation

[LVMVRQUXL]

Description

We would like to introduce an ExperimentalCollectionApi annotation for marking experimental declarations of the kotools.types.collection package.

This new annotation should be available publicly on all platforms.

Checklist

• Follow the Issue implementation section in the contributing guidelines until the Checking the API binaries section.
• Copy the Kotlin code below and paste it before the ExperimentalNumberApi annotation in the Annotations.kt file of the kotools.types.experimental package.

New annotation

/** Marks declarations that are still **experimental** in the collection API. */
@MustBeDocumented
@RequiresOptIn
@Retention(BINARY)
@SinceKotoolsTypes("4.4")
@Target(CLASS, FUNCTION, PROPERTY, TYPEALIAS)
public annotation class ExperimentalCollectionApi

• Check your changes in the generated documentation.
• Check your changes in the public API binaries and update them.
• Copy the following Markdown code block and paste it in the Unreleased section in the CHANGELOG, replacing the YourGitHubProfile placeholder by your GitHub profile (see an example here).

Entry in changelog

### Added

The `ExperimentalCollectionApi` annotation for marking experimental declarations
of the `kotools.types.collection` package (issue [#177] implemented by
[@YourGitHubProfile](#)).

[#177]: https://github.com/kotools/types/issues/177

• Commit your local changes by running the git commit -a command in your terminal with the message below.

Commit message

feat(#177): add 'ExperimentalCollectionApi' annotation

• Create a Pull Request.

[LVMVRQUXL]

We should fix the version specified in the SinceKotoolsTypes annotation:

// Before
@SinceKotoolsTypes(version = "4.4")
public annotation class ExperimentalCollectionApi
// After
@SinceKotoolsTypes(version = "4.3.1")
public annotation class ExperimentalCollectionApi