Kotlin / Kotlin/dataframe

Add KDocs for `append` and `appendNulls`

Open
#1,950 0 comments 0 reactions 1 assignee Claimed by @Allex-Nik View on GitHub
KDocs
Dominant language
Kotlin
Stars
1.1k
Forks
83
Avg merge
4d 12h
Merged PRs (30d)
30

Description

`core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/append.kt` has no KDocs for `DataFrame.append` and `DataFrame.appendNulls`.

The site page exists for `append`: https://kotlin.github.io/dataframe/append.html, but the public APIs should also document their behavior directly in KDoc.

Please add concise KDocs that explain:

- `append` returns a new `DataFrame` with one or more rows appended.
- `append` assigns values row-wise, and the number of values must be a multiple of the dataframe column count.
- `appendNulls` returns a new `DataFrame` with the requested number of rows filled with `null` values.
- `appendNulls(0)` returns the original dataframe.
- Both operations do not mutate the original dataframe.
- Since these operations create a new dataframe/columns, appending rows one by one in a loop is an antipattern; users should prefer constructing data first or appending/concatenating in batches.

### Acceptance criteria

- `DataFrame.append(vararg values: Any?)` has KDoc.
- `DataFrame.appendNulls(numberOfRows: Int = 1)` has KDoc.
- KDocs are consistent with the existing site documentation.
- KDocs explicitly mention immutability and the performance caveat for repeated appends in loops.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.