small explanations about the samples/api split

Kotlin · Oct 2, 2024 · ffaa950 · ffaa950
1 parent 0386c4e
commit ffaa950
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/core/README.md b/core/README.md
@@ -17,8 +17,8 @@ Operations likely to be split off in the future include:
 ### Korro code samples
 
 Code samples for the documentation website reside
-in [core/.../test/.../samples/api](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
-and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
+in [core/.../test/.../samples/api](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples that depend solely on `dataframe-core`),
+and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
 and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
 by [Korro](https://github.com/devcrocod/korro).
 

diff --git a/docs/README.md b/docs/README.md
@@ -28,8 +28,9 @@ Elements annotated with `@ExportAsHtml` will have their generated content be cop
 [docs/StardustDocs/snippets/kdocs](./StardustDocs/snippets/kdocs).
 
 ### Korro code samples
-Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
-and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
+Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
+(for samples that depend solely on `dataframe-core`),
+and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
 and they are copied over to Markdown files in [docs/StardustDocs/topics](./StardustDocs/topics)
 by [Korro](https://github.com/devcrocod/korro).
 

diff --git a/tests/README.md b/tests/README.md
@@ -1,7 +1,8 @@
 ## :tests
 
-Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api),
-and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
+Code samples for the documentation website reside in [core/.../test/.../samples/api](../core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api)
+(for samples that depend solely on `dataframe-core`),
+and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api) (for samples can depend on other I/O modules)
 and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
 by [Korro](https://github.com/devcrocod/korro).