Skip to content

Commit 4d96ef1

Browse files
committed
readme fixes based on feedback from reviews
1 parent edef570 commit 4d96ef1

File tree

9 files changed

+16
-13
lines changed

9 files changed

+16
-13
lines changed

core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ I/O operations are split off into other modules, like [:dataframe-excel](../data
77
or [:dataframe-jdbc](../dataframe-jdbc), however, this is has not happened yet for all operations
88
(see [Issue #100](https://github.com/Kotlin/dataframe/issues/100)).
99

10-
At the moment, these data sources are still part of the `:core` module:
10+
At the moment, these integrations are still part of the `:core` module:
1111

1212
- csv/tsv
1313
- html

dataframe-excel/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## :dataframe-excel
22

33
This module, published as `dataframe-excel`, contains all logic and tests for DataFrame to be able to work with
4-
Excel files.
4+
`xls` and `xlsx` files.
55

66
See [Read from Excel](https://kotlin.github.io/dataframe/read.html#read-from-excel) and
77
[Write to Excel spreadsheet](https://kotlin.github.io/dataframe/write.html#write-to-excel-spreadsheet)

dataframe-openapi-generator/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
## :dataframe-openapi
1+
## :dataframe-openapi-generator
22

33
This module, published as `dataframe-openapi-generator` contains all logic and tests for DataFrame to be able to import
44
OpenAPI specifications as auto-generated data schemas. This module is a sister module to
55
[`dataframe-openapi`](../dataframe-openapi):
66

77
- `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate
8-
data schemas from OpenAPI specifications.
8+
data schemas from OpenAPI specifications. In the Gradle plugin it adds support for the `dataschemas {}` DSL and the
9+
`@file:ImportDataSchema()` annotation. In Jupyter, it adds support for the `importDataSchema()` function.
910
- `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas.
1011

1112
See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and

dataframe-openapi/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ data schemas from OpenAPI specifications. This module is a sister module to
55
[`dataframe-openapi-generator`](../dataframe-openapi-generator):
66

77
- `dataframe-openapi-generator` is used as a dependency of the Gradle plugin and Jupyter plugin to be able to generate
8-
data schemas from OpenAPI specifications.
8+
data schemas from OpenAPI specifications. In the Gradle plugin it adds support for the `dataschemas {}` DSL and the
9+
`@file:ImportDataSchema()` annotation. In Jupyter, it adds support for the `importDataSchema()` function.
910
- `dataframe-openapi` must be used as a dependency of a user-project to be able to use the generated data schemas.
1011

1112
See [Import OpenAPI Schemas in Gradle project](https://kotlin.github.io/dataframe/schemasimportopenapigradle.html) and

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
This folder holds the source code of our documentation website:
44
[kotlin.github.io/dataframe](https://kotlin.github.io/dataframe).
55

6-
It's built using [WriterSide](https://www.jetbrains.com/writerside/) and published
6+
It's built using [Writerside](https://www.jetbrains.com/writerside/) and published
77
by a [Github Action](../.github/workflows/main.yml).
8-
The file structure largely mirrors the default WriterSide structure.
8+
The file structure largely mirrors the default Writerside structure.
99
For instance, if you want to add a new page to the website, this needs to be stored as an `.md` file in the
1010
[StardustDocs/topics](./StardustDocs/topics) folder,
1111
and included in the [StardustDocs/d.tree](./StardustDocs/d.tree) file.

generator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ code in Notebooks or any of our [plugins](../plugins). Words like "package", "fu
1010
As the Kotlin language can change over time, this task ensures that any changes to the language
1111
will be reflected in our code generation.
1212

13-
This module can probably be moved under [:plugins](../plugins):
13+
This module will likely be moved under [:plugins](../plugins):
1414
[Issue #899](https://github.com/Kotlin/dataframe/issues/899).

plugins/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ task `dataframes {}`. It uses [:plugins:symbol-processor](./symbol-processor) to
88

99
### [:plugins:symbol-processor](./symbol-processor)
1010
The KSP plugin that can generate data schemas from a data sample using the `@file:ImportDataSchema` annotation.
11-
It is also used to detect (both manually written- or generated) `@DataSchema` annotated classes/interfaces to generate
12-
column accessors for in the form of extension properties.
11+
It is also used to generate column accessors for in the form of extension properties for
12+
(both manually written- or generated) `@DataSchema` annotated classes/interfaces.
1313

1414
### [:plugins:kotlin-dataframe](./kotlin-dataframe)
1515
The Kotlin 2.x Compiler plugin of DataFrame. A [work-in-progress](https://github.com/Kotlin/dataframe/issues/704)

plugins/kotlin-dataframe/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This module, published as "compiler-plugin-all", holds the Kotlin 2.x Compiler plugin of DataFrame.
44

55
A [work-in-progress](https://github.com/Kotlin/dataframe/issues/704)
6-
plugin for your Gradle project that can generate on-the-fly column accessors for the compiler and IDE even without
6+
plugin for your Kotlin project that can generate on-the-fly column accessors for the compiler and IDE even without
77
having to provide data schemas!
88

9-
Details of how to build and run this for yourself will follow, but there is a
9+
Details of how to use this compiler plugin for your own project will follow, but there is a
1010
[demo project](https://github.com/koperagen/df-plugin-demo) you can try already.

plugins/symbol-processor/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
## :plugins:symbol-processor
22

33
This module holds the KSP plugin, published as the library "symbol-processor-all" that can generate data schemas from
4-
a data sample using the `@file:ImportDataSchema` annotation.
4+
a data sample using the `@file:ImportDataSchema` annotation. This annotation can be used as an alternative to
5+
the `dataframes {}` syntax of the [Gradle plugin](../dataframe-gradle-plugin) that's declared closer to the source code.
56
It is also used to detect (both manually written- or generated) `@DataSchema` annotated classes/interfaces to generate
67
column accessors for in the form of extension properties.
78

0 commit comments

Comments
 (0)