Add minimal KDocs for `print` APIs

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

I maintainer di solito rispondono entro 1 giorno

@zaleslaw ci sta già lavorando.

Dal 4/11/2026.

  • #2220 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 da core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/print.kt e rivedi le sei API pubbliche print elencate e non deprecate, insieme alla loro relazione con renderToString(...). Aggiungi KDocs concisi che descrivano la stampa sull’output standard, l’uso come funzione di utilità o in contesti interattivi e i parametri di DataFrame.print(...). L’attività è completata quando tutte le API elencate sono documentate e gli utenti vengono indirizzati a renderToString(...) quando hanno bisogno di uno String.

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

Descrizione

KDocs

Add minimal KDocs for print APIs

Motivation

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/print.kt contains several public print() functions with no KDoc.

Most of them are intentionally thin convenience wrappers around println(...) or println(renderToString(...)), but this is not visible from the API docs. A minimal KDoc would help users understand when to call print() directly and when to use the underlying string-rendering APIs instead.

In particular, DataFrame.print(...) exposes formatting parameters and delegates to renderToString(...), so its KDoc should clarify that it prints the rendered table to standard output and is mainly intended for quick interactive/debug output.

Scope

Add concise KDocs for public non-deprecated functions in:

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/print.kt

Cover:

  • DataColumn<T>.print()
  • DataRow<T>.print()
  • DataFrame<T>.print(...)
  • GroupBy<T, G>.print()
  • DataFrameSchema.print()
  • CodeString.print()

Deprecated hidden overloads do not need new KDocs unless required by the project’s documentation policy.

Acceptance Criteria

  • Public non-deprecated print APIs have minimal KDocs.
  • KDocs state that these functions print to standard output.
  • DataFrame.print(...) KDoc mentions that it renders via renderToString(...).
  • DataFrame.print(...) parameters are documented briefly enough to explain when to use them.
  • KDocs clarify that print() is a convenience/debug/interactive output API, not a data transformation.
  • KDocs point users to renderToString(...) when they need the rendered table as a String instead of printing it.
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.