Skip to content

Commit 5df50bc

Browse files
committed
added opt in notes to parseExperimentalUuid
1 parent ab463e1 commit 5df50bc

File tree

1 file changed

+9
-0
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+9
-0
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/parse.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ import java.time.format.DateTimeFormatter
2020
import java.util.Locale
2121
import kotlin.reflect.KProperty
2222
import kotlin.reflect.KType
23+
import kotlin.uuid.ExperimentalUuidApi
24+
import kotlin.uuid.Uuid
2325

2426
/**
2527
* ### Global Parser Options
@@ -77,6 +79,10 @@ public interface GlobalParserOptions {
7779
/**
7880
* Whether to allow parsing UUIDs to the experimental [kotlin.uuid.Uuid] type.
7981
* By default, this is false and UUIDs are not recognized.
82+
*
83+
* NOTE: Interacting with a [Uuid][Uuid] in your code might require
84+
* `@`[OptIn][OptIn]`(`[ExperimentalUuidApi][ExperimentalUuidApi]`::class)`.
85+
* In notebooks, add `-opt-in=kotlin.uuid.ExperimentalUuidApi` to the compiler arguments.
8086
*/
8187
public var parseExperimentalUuid: Boolean
8288
}
@@ -109,6 +115,9 @@ public interface GlobalParserOptions {
109115
* @param useFastDoubleParser whether to use [FastDoubleParser], defaults to `true`. Please report any issues you encounter.
110116
* @param parseExperimentalUuid whether to allow parsing UUIDs to the experimental [kotlin.uuid.Uuid] type.
111117
* By default, this is false and UUIDs are not recognized.
118+
* NOTE: Interacting with a [Uuid][Uuid] in your code might require
119+
* `@`[OptIn][OptIn]`(`[ExperimentalUuidApi][ExperimentalUuidApi]`::class)`.
120+
* In notebooks, add `-opt-in=kotlin.uuid.ExperimentalUuidApi` to the compiler arguments.
112121
*/
113122
public class ParserOptions(
114123
public val locale: Locale? = null,

0 commit comments

Comments
 (0)