Add an example in the documentation for List<List<T>>.toDataFrame

Author: koperagen

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

@@ -425,4 +425,22 @@ class Create : TestBase() {
         val df = files.toDataFrame(columnName = "data")
         // SampleEnd
     }
+
+    @Test
+    @TransformDataFrameExpressions
+    fun toDataFrameLists() {
+        // SampleStart
+        val lines = """
+            1
+            00:00:05,000 --> 00:00:07,500
+            This is the first subtitle.
+
+            2
+            00:00:08,000 --> 00:00:10,250
+            This is the second subtitle.
+        """.trimIndent().lines()
+
+        lines.chunked(4) { it.take(3) }.toDataFrame(header = listOf("n", "timestamp", "text"))
+        // SampleEnd
+    }
 }

docs/StardustDocs/topics/_shadow_resources.md

@@ -88,6 +88,7 @@
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Analyze.statisticGroupBySingle.html"></resource>
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Access.takeLast.html"></resource>
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Create.toDataFrameColumn.html"></resource>
+<resource src="org.jetbrains.kotlinx.dataframe.samples.api.Create.toDataFrameLists.html"></resource>
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Modify.updateWith.html"></resource>
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Modify.addRecurrent.html"></resource>
 <resource src="org.jetbrains.kotlinx.dataframe.samples.api.Analyze.groupByWithoutAggregation.html"></resource>
@@ -199,4 +200,4 @@
 <resource src="formatHeader.html"></resource>
 <resource src="notebook_test_rename_3.html"></resource>
 <resource src="notebook_test_rename_4.html"></resource>
-<resource src="notebook_test_rename_5.html"></resource>
+<resource src="notebook_test_rename_5.html"></resource>

docs/StardustDocs/topics/createDataFrame.md

@@ -160,6 +160,29 @@ val df = files.toDataFrame(columnName = "data")
 <inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Create.toDataFrameColumn.html" width="100%"/>
 <!---END-->
 
+Creates a [`DataFrame`](DataFrame.md) from a `List<List<T>>`:
+
+This is useful for parsing text files. For example, the `.srt` subtitle format can be parsed like this:
+
+<!---FUN toDataFrameLists-->
+
+```kotlin
+val lines = """
+    1
+    00:00:05,000 --> 00:00:07,500
+    This is the first subtitle.
+
+    2
+    00:00:08,000 --> 00:00:10,250
+    This is the second subtitle.
+""".trimIndent().lines()
+
+lines.chunked(4) { it.take(3) }.toDataFrame(header = listOf("n", "timestamp", "text"))
+```
+
+<inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Create.toDataFrameLists.html" width="100%"/>
+<!---END-->
+
 Creates a [`DataFrame`](DataFrame.md) from an [`Iterable`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/) of objects:
 
 <!---FUN readDataFrameFromObject-->