From 4d96ef1cc2400ffb05d692db6f8bd1b5acfc65eb Mon Sep 17 00:00:00 2001 From: Jolan Rensen Date: Fri, 25 Oct 2024 13:11:00 +0200 Subject: [PATCH] readme fixes based on feedback from reviews --- core/README.md | 2 +- dataframe-excel/README.md | 2 +- dataframe-openapi-generator/README.md | 5 +++-- dataframe-openapi/README.md | 3 ++- docs/README.md | 4 ++-- generator/README.md | 2 +- plugins/README.md | 4 ++-- plugins/kotlin-dataframe/README.md | 4 ++-- plugins/symbol-processor/README.md | 3 ++- 9 files changed, 16 insertions(+), 13 deletions(-) diff --git a/core/README.md b/core/README.md index 41517654e..cb07c1b44 100644 --- a/core/README.md +++ b/core/README.md @@ -7,7 +7,7 @@ I/O operations are split off into other modules, like [:dataframe-excel](../data or [:dataframe-jdbc](../dataframe-jdbc), however, this is has not happened yet for all operations (see [Issue #100](https://github.com/Kotlin/dataframe/issues/100)). -At the moment, these data sources are still part of the `:core` module: +At the moment, these integrations are still part of the `:core` module: - csv/tsv - html diff --git a/dataframe-excel/README.md b/dataframe-excel/README.md index 4dc59671c..31c6f7aea 100644 --- a/dataframe-excel/README.md +++ b/dataframe-excel/README.md @@ -1,7 +1,7 @@ ## :dataframe-excel This module, published as `dataframe-excel`, contains all logic and tests for DataFrame to be able to work with -Excel files. +`xls` and `xlsx` files. See [Read from Excel](https://kotlin.github.io/dataframe/read.html#read-from-excel) and [Write to Excel spreadsheet](https://kotlin.github.io/dataframe/write.html#write-to-excel-spreadsheet) diff --git a/dataframe-openapi-generator/README.md b/dataframe-openapi-generator/README.md index f65b1a73c..06deff05d 100644 --- a/dataframe-openapi-generator/README.md +++ b/dataframe-openapi-generator/README.md @@ -1,11 +1,12 @@ -## :dataframe-openapi +## :dataframe-openapi-generator This module, published as `dataframe-openapi-generator` contains all logic and tests for DataFrame to be able to import OpenAPI specifications as auto-generated data schemas. This module is a sister module to [`dataframe-openapi`](../dataframe-openapi): - `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate - data schemas from OpenAPI specifications. + data schemas from OpenAPI specifications. In the Gradle plugin it adds support for the `dataschemas {}` DSL and the + `@file:ImportDataSchema()` annotation. In Jupyter, it adds support for the `importDataSchema()` function. - `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas. See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and diff --git a/dataframe-openapi/README.md b/dataframe-openapi/README.md index 29a1341ca..435407a8a 100644 --- a/dataframe-openapi/README.md +++ b/dataframe-openapi/README.md @@ -5,7 +5,8 @@ data schemas from OpenAPI specifications. This module is a sister module to [`dataframe-openapi-generator`](../dataframe-openapi-generator): - `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate - data schemas from OpenAPI specifications. + data schemas from OpenAPI specifications. In the Gradle plugin it adds support for the `dataschemas {}` DSL and the + `@file:ImportDataSchema()` annotation. In Jupyter, it adds support for the `importDataSchema()` function. - `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas. See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and diff --git a/docs/README.md b/docs/README.md index e33d3cce3..633c7d7d0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,9 +3,9 @@ This folder holds the source code of our documentation website: [kotlin.github.io/dataframe](https://kotlin.github.io/dataframe). -It's built using [WriterSide](https://www.jetbrains.com/writerside/) and published +It's built using [Writerside](https://www.jetbrains.com/writerside/) and published by a [Github Action](../.github/workflows/main.yml). -The file structure largely mirrors the default WriterSide structure. +The file structure largely mirrors the default Writerside structure. For instance, if you want to add a new page to the website, this needs to be stored as an `.md` file in the [StardustDocs/topics](./StardustDocs/topics) folder, and included in the [StardustDocs/d.tree](./StardustDocs/d.tree) file. diff --git a/generator/README.md b/generator/README.md index 32e2ec994..fceabae25 100644 --- a/generator/README.md +++ b/generator/README.md @@ -10,5 +10,5 @@ code in Notebooks or any of our [plugins](../plugins). Words like "package", "fu As the Kotlin language can change over time, this task ensures that any changes to the language will be reflected in our code generation. -This module can probably be moved under [:plugins](../plugins): +This module will likely be moved under [:plugins](../plugins): [Issue #899](https://github.com/Kotlin/dataframe/issues/899). diff --git a/plugins/README.md b/plugins/README.md index 4626e5e94..2d1dd1dbd 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -8,8 +8,8 @@ task `dataframes {}`. It uses [:plugins:symbol-processor](./symbol-processor) to ### [:plugins:symbol-processor](./symbol-processor) The KSP plugin that can generate data schemas from a data sample using the `@file:ImportDataSchema` annotation. -It is also used to detect (both manually written- or generated) `@DataSchema` annotated classes/interfaces to generate -column accessors for in the form of extension properties. +It is also used to generate column accessors for in the form of extension properties for +(both manually written- or generated) `@DataSchema` annotated classes/interfaces. ### [:plugins:kotlin-dataframe](./kotlin-dataframe) The Kotlin 2.x Compiler plugin of DataFrame. A [work-in-progress](https://github.com/Kotlin/dataframe/issues/704) diff --git a/plugins/kotlin-dataframe/README.md b/plugins/kotlin-dataframe/README.md index 7d79c5831..7fbb5a6d2 100644 --- a/plugins/kotlin-dataframe/README.md +++ b/plugins/kotlin-dataframe/README.md @@ -3,8 +3,8 @@ This module, published as "compiler-plugin-all", holds the Kotlin 2.x Compiler plugin of DataFrame. A [work-in-progress](https://github.com/Kotlin/dataframe/issues/704) -plugin for your Gradle project that can generate on-the-fly column accessors for the compiler and IDE even without +plugin for your Kotlin project that can generate on-the-fly column accessors for the compiler and IDE even without having to provide data schemas! -Details of how to build and run this for yourself will follow, but there is a +Details of how to use this compiler plugin for your own project will follow, but there is a [demo project](https://github.com/koperagen/df-plugin-demo) you can try already. diff --git a/plugins/symbol-processor/README.md b/plugins/symbol-processor/README.md index 994577561..83e085043 100644 --- a/plugins/symbol-processor/README.md +++ b/plugins/symbol-processor/README.md @@ -1,7 +1,8 @@ ## :plugins:symbol-processor This module holds the KSP plugin, published as the library "symbol-processor-all" that can generate data schemas from -a data sample using the `@file:ImportDataSchema` annotation. +a data sample using the `@file:ImportDataSchema` annotation. This annotation can be used as an alternative to +the `dataframes {}` syntax of the [Gradle plugin](../dataframe-gradle-plugin) that's declared closer to the source code. It is also used to detect (both manually written- or generated) `@DataSchema` annotated classes/interfaces to generate column accessors for in the form of extension properties.