Skip to content

Commit 846c9ad

Browse files
committed
small explanations about the samples/api split
1 parent 0386c4e commit 846c9ad

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Operations likely to be split off in the future include:
1717
### Korro code samples
1818

1919
Code samples for the documentation website reside
20-
in [core/.../test/.../samples/api](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
21-
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
20+
in [core/.../test/.../samples/api](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples that depend solely on `dataframe-core`),
21+
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
2222
and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
2323
by [Korro](https://github.com/devcrocod/korro).
2424

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ Elements annotated with `@ExportAsHtml` will have their generated content be cop
2828
[docs/StardustDocs/snippets/kdocs](./StardustDocs/snippets/kdocs).
2929

3030
### Korro code samples
31-
Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
32-
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
31+
Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
32+
(for samples that depend solely on `dataframe-core`),
33+
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
3334
and they are copied over to Markdown files in [docs/StardustDocs/topics](./StardustDocs/topics)
3435
by [Korro](https://github.com/devcrocod/korro).
3536

tests/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
## :tests
22

3-
Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
4-
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
3+
Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
4+
(for samples that depend solely on `dataframe-core`),
5+
and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
56
and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
67
by [Korro](https://github.com/devcrocod/korro).
78

8-
This module should likely be moved into [:core](../core): [Issue #898](https://github.com/Kotlin/dataframe/issues/898).
9+
This module might be merged with [:core](../core): [Issue #898](https://github.com/Kotlin/dataframe/issues/898).

0 commit comments

Comments
 (0)