Skip to content

Commit 236505a

Browse files
modules fixes
1 parent d281407 commit 236505a

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/StardustDocs/topics/gettingStarted/Modules.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ dependencies {
132132

133133
## Core Kotlin DataFrame modules {id="core-modules"}
134134

135-
### `dataframe-core`
135+
#### `dataframe-core`
136136

137137
The core [DataFrame](DataFrame.md) API and its implementation.
138138
Includes all core functionality for working with data structures, expressions, schema management, and operations.
@@ -372,7 +372,7 @@ dependencies {
372372

373373
These modules are experimental and may be unstable.
374374

375-
### `dataframe-geo`
375+
#### `dataframe-geo`
376376

377377
Provides a new API for working with geospatial data,
378378
including reading and writing geospatial formats (GeoJSON, Shapefile),
@@ -414,7 +414,7 @@ dependencies {
414414
</tab>
415415
</tabs>
416416

417-
### `dataframe-openapi`
417+
#### `dataframe-openapi`
418418

419419
Provides functionality to support auto-generated data schemas from OpenAPI 3.0.0 specifications.
420420
This module is a companion to [`dataframe-openapi-generator`](#dataframe-openapi-generator):
@@ -452,7 +452,7 @@ dependencies {
452452
</tab>
453453
</tabs>
454454

455-
### `dataframe-openapi-generator`
455+
#### `dataframe-openapi-generator`
456456

457457
Provides the logic and tooling necessary to import OpenAPI 3.0.0 specifications
458458
as auto-generated data schemas for Kotlin DataFrame.
@@ -495,7 +495,7 @@ dependencies {
495495

496496
<!-- TODO improve compiler plugin setup after release--->
497497

498-
## `kotlin.plugin.dataframe` — Kotlin DataFrame Compiler Plugin {id="kotlin.plugin.dataframe"}
498+
#### `kotlin.plugin.dataframe` — Kotlin DataFrame Compiler Plugin {id="kotlin.plugin.dataframe"}
499499

500500
The Kotlin DataFrame compiler plugin enables support for [extension properties](extensionPropertiesApi.md)
501501
in Gradle projects, allowing you to work with dataframes in a name- and type-safe manner.
@@ -506,12 +506,13 @@ and usage instructions for Gradle projects.
506506
Published as a Kotlin official plugin.
507507
[Source code is available in the Kotlin repository](https://github.com/JetBrains/kotlin/tree/master/plugins/kotlin-dataframe).
508508

509-
## `kotlinx.dataframe` – Gradle Plugin {id="kotlinx.dataframe"}
509+
#### `kotlinx.dataframe` – Gradle Plugin {id="kotlinx.dataframe"}
510510

511-
The Gradle plugin allows generating [data schemas](schemas.md) for external resources
512-
using Gradle, so you can use them seamlessly in your project.
511+
The Gradle plugin allows generating [data schemas](schemas.md) from samples of data
512+
(of supported formats) like JSON, CSV, Excel files, or URLs, as well as from data fetched from SQL databases
513+
using Gradle.
513514

514-
See the [Gradle Plugin Reference](gradleReference.md) for installation
515+
See the [Gradle Plugin Reference](DataSchemaGenerationGradle.md) for installation
515516
and usage instructions in Gradle projects.
516517

517518
> By default, the Gradle plugin also applies the [KSP plugin](#ksp-plugin).
@@ -537,10 +538,11 @@ plugins {
537538
</tabs>
538539

539540

540-
## `kotlinx.dataframe:symbol-processor-all` – KSP Plugin {id="ksp-plugin"}
541+
#### `kotlinx.dataframe:symbol-processor-all` – KSP Plugin {id="ksp-plugin"}
541542

542-
The KSP plugin allows generating [data schemas](schemas.md) from external resources
543-
using Kotlin Symbol Processing (KSP).
543+
The Gradle plugin allows generating [data schemas](schemas.md) from samples of data
544+
(of supported formats) like JSON, CSV, Excel files, or URLs, as well as from data fetched from SQL databases
545+
using Kotlin Symbol Processing (KSP).
544546
This is useful for projects where you prefer or require schema generation at the source level.
545547

546548
See [Data Schemas in Gradle Projects](schemasGradle.md) for usage details.

0 commit comments

Comments
 (0)