Add KDoc for `Implode`
@AndreiKingsley is already working on this.
Since Aug 15, 2025.
- Dominant language
- Kotlin
- Stars
- 1.1k
- Forks
- 83
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 30
Description
Add KDoc for implode
Add KDocs for public non-deprecated implode overloads in:
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/implode.kt
Issue: https://github.com/Kotlin/dataframe/issues/1385
Website page: https://kotlin.github.io/dataframe/implode.html
Docs source: docs/StardustDocs/topics/implode.md
The KDoc should be aligned with the existing website page: implode returns a DataFrame where values in selected columns are merged into lists grouped by the remaining columns.
Cover overloads:
DataFrame<T>.implode(dropNA: Boolean = false): DataRow<T>DataFrame<T>.implode(dropNA: Boolean = false, columns: ColumnsSelector<T, C>): DataFrame<T>DataFrame<T>.implode(vararg columns: String, dropNA: Boolean = false): DataFrame<T>
Do not spend effort on deprecated access API overloads except keeping them consistent if needed.
Mention key behavior:
- selected columns are imploded, other columns are used as grouping keys;
dropNA = trueremovesNAvalues from merged lists;- value columns change type from
TtoList<T>; DataRow/ColumnGroupvalues are converted into dataframe/frame-column representation, as described on the website;implodeis the reverse operation ofexplode.
Add a documentation URL snippet for implode to DocumentationUrls if missing, similar to Explode.
Use explode.kt KDocs as the closest style/reference.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.