Add KDocs for `merge` APIs

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,975 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@zaleslaw ci sta già lavorando.

Dal 29/9/2026.

  • #2210 di @zaleslaw — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
kotlin
Ambito
documentation

Direzione di ricerca

Inizia in core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/merge.kt e confronta le API pubbliche non deprecate con la pagina merge. Aggiungi KDocs concisi per merge, notNull, by, into e intoList, saltando gli overload deprecati di access-api. Il lavoro è completato quando tutte le API elencate sono documentate in modo coerente con il flusso merge documentato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

KDocs

Add KDocs for merge APIs

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/merge.kt contains public merge APIs without KDocs.

The site page already describes the main behavior:
https://kotlin.github.io/dataframe/merge.html

KDocs should be aligned with the documented merge flow:

merge { columns }
    [.notNull()]
    .by(delimiter) | .by { merger }
    [.into(column) | .intoList()]
What it does

merge combines several selected columns into a single result per row.

By default, selected values are collected into a List.

The result can be written back into a dataframe with into(...), or returned as a standalone list with intoList().

Scope

Add concise KDocs for non-deprecated public APIs in merge.kt:

  • DataFrame.merge { ... }
  • DataFrame.merge(vararg columns: String)
  • Merge.notNull()
  • Merge.asStrings()
  • Merge.by(separator, prefix, postfix, limit, truncated)
  • Merge.by { ... }
  • Merge.into(columnName: String)
  • Merge.into(path: ColumnPath)
  • MergeWithTransform.into(columnName: String)
  • MergeWithTransform.into(path: ColumnPath)
  • Merge.intoList()
  • MergeWithTransform.intoList()

Deprecated access-api overloads do not need new KDocs.

KDocs should explain
  • merge is the reverse operation of split.
  • Selected column values are collected row-wise.
  • Without by(...), values are merged into List.
  • by(separator, ...) joins selected values into a String.
  • by { ... } allows custom transformation of collected row values.
  • notNull() removes null values and empty row values before merging.
  • into(...) writes the merged result into the target column/path.
  • intoList() returns merged values without modifying the dataframe structure.
  • When heterogeneous columns are merged, users may need explicit casts inside the merger lambda.
Acceptance criteria
  • Non-deprecated public merge APIs have concise KDocs.
  • Deprecated access-api overloads are skipped.
  • KDocs are consistent with the site page.
  • KDocs cover notNull, by, into, and intoList.
Lingua principale
Kotlin
Stelle
1.1k
Fork
87
Merge medio
2g 21h
PR unite (30g)
40

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Kotlin/dataframe

Tutte le issue di Kotlin/dataframe

Issue simili

Altre issue su Kotlin

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.