Skip to content

Commit

Permalink
readme fixes based on feedback from reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
Jolanrensen committed Oct 25, 2024
1 parent edef570 commit 4d96ef1
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 13 deletions.
2 changes: 1 addition & 1 deletion core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dataframe-excel/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
5 changes: 3 additions & 2 deletions dataframe-openapi-generator/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion dataframe-openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions plugins/kotlin-dataframe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion plugins/symbol-processor/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 4d96ef1

Please sign in to comment.