From ecc6402c76ac2bbc1db584db0845035bc6c5bb67 Mon Sep 17 00:00:00 2001 From: Jolan Rensen Date: Thu, 5 Jun 2025 12:32:43 +0200 Subject: [PATCH 1/2] various docs fixes to lower the number of errors --- docs/README.md | 2 - docs/StardustDocs/topics/ColumnSelectors.md | 4 +- docs/StardustDocs/topics/Compiler-Plugin.md | 4 +- docs/StardustDocs/topics/_shadow_resources.md | 2 +- .../gettingStartedGradleAdvanced.md | 2 +- ...n-DataFrame-Features-in-Kotlin-Notebook.md | 24 +++++++++--- docs/StardustDocs/topics/median.md | 20 +++++----- docs/StardustDocs/topics/minmax.md | 20 +++++----- docs/StardustDocs/topics/parse.md | 39 +++++++++++++++++++ docs/StardustDocs/topics/percentile.md | 20 +++++----- 10 files changed, 94 insertions(+), 43 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7fbaa78f6a..3471d1bebf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -62,5 +62,3 @@ Code samples for the documentation website reside in [core/.../test/.../samples/ and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules) and they are copied over to Markdown files in [docs/StardustDocs/topics](./StardustDocs/topics) by [Korro](https://github.com/devcrocod/korro). - - diff --git a/docs/StardustDocs/topics/ColumnSelectors.md b/docs/StardustDocs/topics/ColumnSelectors.md index eded79ccff..05ebe4f904 100644 --- a/docs/StardustDocs/topics/ColumnSelectors.md +++ b/docs/StardustDocs/topics/ColumnSelectors.md @@ -51,7 +51,7 @@ or `ColumnSet` that adheres to the optional given condition. If no column adhere ##### Col {collapsible="true"} `col(name)`, `col(5)`, `this[5]` -Creates a [ColumnAccessor](DataColumn.md#column-accessors) (or `SingleColumn`) for a column with the given +Creates a [ColumnAccessor](DataColumn.md) (or `SingleColumn`) for a column with the given argument from the top-level or specified [column group](DataColumn.md#columngroup). The argument can be either an index (`Int`) or a reference to a column (`String`, `ColumnPath`, `KProperty`, or `ColumnAccessor`; any [AccessApi](apiLevels.md)). @@ -59,7 +59,7 @@ any [AccessApi](apiLevels.md)). ##### Value Col, Frame Col, Col Group {collapsible="true"} `valueCol(name)`, `valueCol(5)`, `frameCol(name)`, `frameCol(5)`, `colGroup(name)`, `colGroup(5)` -Creates a [ColumnAccessor](DataColumn.md#column-accessors) (or `SingleColumn`) for a +Creates a [ColumnAccessor](DataColumn.md) (or `SingleColumn`) for a [value column](DataColumn.md#valuecolumn) / [frame column](DataColumn.md#framecolumn) / [column group](DataColumn.md#columngroup) with the given argument from the top-level or specified [column group](DataColumn.md#columngroup). The argument can be either an index (`Int`) or a reference diff --git a/docs/StardustDocs/topics/Compiler-Plugin.md b/docs/StardustDocs/topics/Compiler-Plugin.md index dbf0bf3648..5cd1dbfa37 100644 --- a/docs/StardustDocs/topics/Compiler-Plugin.md +++ b/docs/StardustDocs/topics/Compiler-Plugin.md @@ -3,7 +3,9 @@ Kotlin DataFrame compiler plugin: available in Gradle projects, is coming to Kotlin Notebook and Maven projects soon. Check out this video that shows how expressions update the schema of a dataframe: -