Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/README_GH_ACTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ fails if any unknown Gradle Wrapper JAR files are found.

Anytime the source code changes on [master](https://github.com/Kotlin/dataframe/tree/master),
this [GitHub Action](./workflows/generated-sources-master.yml) makes sure
[`processKDocsMain`](../KDOC_PREPROCESSING.md),
[`processKDocsMain`](../KODEX_KDOC_PREPROCESSING.md),
and `korro` are run. If there have been any changes in either [core/generated-sources](../core/generated-sources) or
[docs/StardustDocs/resources/snippets](../docs/StardustDocs/resources/snippets), these are auto-committed to the branch, to keep
it up to date.
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ has the best support for Kotlin, compiler plugins, Gradle, and [Kotlin Notebook]
* We recommend using the [Ktlint plugin](https://plugins.jetbrains.com/plugin/15057-ktlint) for [IntelliJ IDEA](https://www.jetbrains.com/idea/download/).
It is able to read the `.editorconfig` file and apply the same formatting rules as [Ktlint](https://pinterest.github.io/ktlint/latest/) in the CI.

* Check out the [KDoc Preprocessor guide](KDOC_PREPROCESSING.md) to understand how to work with
* Check out the [KDoc Preprocessor guide](KODEX_KDOC_PREPROCESSING.md) to understand how to work with
[KoDEx](https://github.com/Jolanrensen/KoDEx).

## Building
Expand All @@ -108,7 +108,7 @@ This library is built with Gradle.
things up during development.
* Make sure to pass the extra parameter `-Pkotlin.dataframe.debug=true` to enable debug mode. This flag will
make sure some extra checks are run, which are important but too heavy for production.
* The parameter `-PskipKodex` allows you to skip [kdoc processing](KDOC_PREPROCESSING.md),
* The parameter `-PskipKodex` allows you to skip [kdoc processing](KODEX_KDOC_PREPROCESSING.md),
making local publishing faster: `./gradlew publishToMavenLocal -PskipKodex`.
This, however, publishes the library with "broken" KDocs,
so it's only meant for faster iterations during development.
Expand Down
723 changes: 723 additions & 0 deletions KDOC_GUIDELINES.md

Large diffs are not rendered by default.

738 changes: 0 additions & 738 deletions KDOC_PREPROCESSING.md

This file was deleted.

Loading