Skip to content

Commit af1b99c

Browse files
committed
Add emptyDataFrame to documentation
1 parent 723655b commit af1b99c

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import org.jetbrains.kotlinx.dataframe.api.add
66
import org.jetbrains.kotlinx.dataframe.api.column
77
import org.jetbrains.kotlinx.dataframe.api.columnGroup
88
import org.jetbrains.kotlinx.dataframe.api.columnOf
9+
import org.jetbrains.kotlinx.dataframe.api.emptyDataFrame
910
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
1011
import org.jetbrains.kotlinx.dataframe.api.filter
1112
import org.jetbrains.kotlinx.dataframe.api.frameColumn
@@ -199,6 +200,15 @@ class Create : TestBase() {
199200
// SampleEnd
200201
}
201202

203+
@Test
204+
fun createEmptyDataFrame() {
205+
// SampleStart
206+
val df = emptyDataFrame()
207+
// SampleEnd
208+
df.columnsCount() shouldBe 0
209+
df.rowsCount() shouldBe 0
210+
}
211+
202212
@Test
203213
fun createDataFrameOf() {
204214
// SampleStart

docs/StardustDocs/topics/createDataFrame.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33

44
This section describes ways to create [`DataFrame`](DataFrame.md).
55

6+
### emptyDataFrame
7+
8+
Returns [`DataFrame`](DataFrame.md) with no rows and no columns.
9+
10+
<!---FUN createEmptyDataFrame-->
11+
12+
```kotlin
13+
val df = emptyDataFrame()
14+
```
15+
16+
<!---END-->
17+
618
### dataFrameOf
719

820
Returns [`DataFrame`](DataFrame.md) with given column names and values.

0 commit comments

Comments
 (0)