From fccd89e0946512e38eee5d9f2e172a7fd0f81966 Mon Sep 17 00:00:00 2001 From: Nikita Klimenko Date: Fri, 23 May 2025 13:45:41 +0300 Subject: [PATCH] Minor fixes for the docs --- docs/StardustDocs/topics/Compiler-Plugin.md | 2 ++ docs/StardustDocs/topics/dataSchema.md | 4 +--- docs/StardustDocs/topics/staticInterpretation.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/StardustDocs/topics/Compiler-Plugin.md b/docs/StardustDocs/topics/Compiler-Plugin.md index 0ee3433f61..1de4625209 100644 --- a/docs/StardustDocs/topics/Compiler-Plugin.md +++ b/docs/StardustDocs/topics/Compiler-Plugin.md @@ -55,6 +55,8 @@ Add this line to `gradle.properties`: ```properties kotlin.incremental=false ``` + +`Sync` the project. Disabling incremental compilation will no longer be necessary when https://youtrack.jetbrains.com/issue/KT-66735 is resolved. diff --git a/docs/StardustDocs/topics/dataSchema.md b/docs/StardustDocs/topics/dataSchema.md index 89ab0faceb..466dac5c6a 100644 --- a/docs/StardustDocs/topics/dataSchema.md +++ b/docs/StardustDocs/topics/dataSchema.md @@ -1,6 +1,6 @@ # @DataSchema declarations -`DataSchema` can be used as an argument for cast and convertTo functions. +`DataSchema` can be used as an argument for [cast](cast.md) and [convertTo](convertTo.md) functions. It provides typed data access for raw dataframes you read from I/O sources and serves as a starting point for the compiler plugin to derive schema changes. Example 1: @@ -182,5 +182,3 @@ data class Name( val url = "https://raw.githubusercontent.com/Kotlin/dataframe/refs/heads/master/data/participants.json" val df = DataFrame.readJson(url).cast() ``` - - diff --git a/docs/StardustDocs/topics/staticInterpretation.md b/docs/StardustDocs/topics/staticInterpretation.md index dcc2bc321d..df163460fd 100644 --- a/docs/StardustDocs/topics/staticInterpretation.md +++ b/docs/StardustDocs/topics/staticInterpretation.md @@ -73,8 +73,8 @@ Compiler plugin aims to cover all functions where the result of the operation de In the library, such functions are annotated with `@Refine` or `@Interpretable`. There are functions that are not supported: -`pivot`, `parse`, `read`, `ColumnSelectionDsl.filter`, etc. — operations where the resulting schema depends on data, so it's out of the scope -`gather`, `split`, `implode`, some CS DSL functions — they will be supported in the future release +- `pivot`, `parse`, `read`, `ColumnSelectionDsl.filter`, etc. — operations where the resulting schema depends on data, so it's out of the scope +- `gather`, `split`, `implode`, some CS DSL functions — they will be supported in the future release In Gradle projects it means that sometimes you'd need to provide [data schema](dataSchema.md) or fall back to String API.