Skip to content

Commit 58303bf

Browse files
committed
clarified value class example
1 parent 84bae15 commit 58303bf

File tree

2 files changed

+4
-4
lines changed
  • core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api
  • docs/StardustDocs/topics

2 files changed

+4
-4
lines changed

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Modify.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ class Modify : TestBase() {
223223
@TransformDataFrameExpressions
224224
fun convertToValueClass() {
225225
// SampleStart
226-
dataFrameOf("value")("1", "2")
226+
dataFrameOf("value")("1", "2") // note that values are strings; conversion is done automatically
227227
.convert("value").to<IntClass>()
228228
// SampleEnd
229229
}

docs/StardustDocs/topics/convert.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ dataFrameOf("direction")("NORTH", "WEST")
8181
<dataFrame src="org.jetbrains.kotlinx.dataframe.samples.api.Modify.convertToEnum.html"/>
8282
<!---END-->
8383

84-
And finally, [Value classes](https://kotlinlang.org/docs/inline-classes.html) can be created
85-
and unpacked using `convert`:
84+
And finally, [Value classes](https://kotlinlang.org/docs/inline-classes.html) can be used with `convert` too.
85+
Both as conversion source and target:
8686

8787
```kotlin
8888
@JvmInline
@@ -92,7 +92,7 @@ value class IntClass(val value: Int)
9292
<!---FUN convertToValueClass-->
9393

9494
```kotlin
95-
dataFrameOf("value")("1", "2")
95+
dataFrameOf("value")("1", "2") // note that values are strings; conversion is done automatically
9696
.convert("value").to<IntClass>()
9797
```
9898

0 commit comments

Comments
 (0)