Merge pull request #1414 from Kotlin/util_functions_docs

Util functions docs

Author: AndreiKingsley

.gitignore

@@ -9,3 +9,6 @@
 build
 .ipynb_checkpoints
 local.properties
+
+# macOS
+.DS_Store

build.gradle.kts

@@ -34,6 +34,8 @@ plugins {
         // dependence on our own plugin
         alias(dataframe) apply false
         alias(ksp) apply false
+
+        alias(dataframePlugin) apply false
     }
 }
 
@@ -158,7 +160,7 @@ val modulesUsingJava11 = with(projects) {
         dataframeGeoJupyter,
         examples.ideaExamples.titanic,
         examples.ideaExamples.unsupportedDataSources,
-        tests,
+        samples,
         plugins.dataframeGradlePlugin,
     )
 }.map { it.path }

core/README.md

@@ -10,15 +10,29 @@ At the moment, these integrations are still part of the `:core` module:
 - (deprecated) csv/tsv
 - html
 
-### Korro code samples
+### KoDEx
+
+The code you're working on needs to be edited in [src](src), but the KDocs are processed by
+[KoDEx](https://github.com/Jolanrensen/kodex) when the project is published (or the task
+is run manually). The generated sources with adjusted KDocs will be overwritten
+in [generated-sources](generated-sources).
+See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more information.
+
+KDocs can also be exported to HTML, for them to be reused on the website.
+Elements annotated with `@ExportAsHtml` will have their generated content be copied over to
+[docs/StardustDocs/resources/snippets/kdocs](../docs/StardustDocs/resources/snippets/kdocs).
+
+### ~~Korro~~ (NOTE: This is being moved to [:samples](../samples))
+
+> [Should be removed and moved to `:samples` module](https://github.com/Kotlin/dataframe/issues/898).
+
+Tests in this module contain code samples used for import into documentation 
+using [Korro](https://github.com/devcrocod/korro).
 
-Code samples for the documentation website reside
-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).
 
-### ~~Explainer dataframes~~ NOTE: This is being moved to [tests](../tests)
+### ~~Explainer dataframes~~ (NOTE: This is being moved to [:samples](../samples))
+
+> [Should be removed and migrated to SampleHelper](https://github.com/Kotlin/dataframe/issues/898).
 
 Aside from code samples, `@TransformDataFrameExpressions` annotated test functions also generate sample
 dataframe HTML files that can be used as iFrames on the documentation website.
@@ -31,15 +45,3 @@ retrieves the intermediate DataFrame expressions thanks to our "explainer" compi
 We can also generate "normal" DataFrame samples for the website. This can be done using the
 [OtherSamples class](./src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt). Generated
 HTML files will be stored in [docs/StardustDocs/resources/snippets/manual](../docs/StardustDocs/resources/snippets/manual).
-
-### KoDEx
-
-The code you're working on needs to be edited in [src](src), but the KDocs are processed by
-[KoDEx](https://github.com/Jolanrensen/kodex) when the project is published (or the task
-is run manually). The generated sources with adjusted KDocs will be overwritten
-in [generated-sources](generated-sources).
-See the [KDoc Preprocessing Guide](../KDOC_PREPROCESSING.md) for more information.
-
-KDocs can also be exported to HTML, for them to be reused on the website.
-Elements annotated with `@ExportAsHtml` will have their generated content be copied over to
-[docs/StardustDocs/resources/snippets/kdocs](../docs/StardustDocs/resources/snippets/kdocs).

docs/StardustDocs/d.tree

@@ -71,6 +71,7 @@
             <toc-element topic="columnNames.md"/>
             <toc-element topic="columnTypes.md"/>
             <toc-element topic="head.md"/>
+            <toc-element topic="tail.md"/>
             <toc-element topic="schema.md"/>
             <toc-element topic="describe.md"/>
         </toc-element>
@@ -84,6 +85,7 @@
                 <toc-element topic="last.md"/>
                 <toc-element topic="minBy.md"/>
                 <toc-element topic="maxBy.md"/>
+                <toc-element topic="asSequence.md"/>
             </toc-element>
             <toc-element topic="getColumns.md">
                 <toc-element topic="columns.md"/>
@@ -127,7 +129,6 @@
             <toc-element topic="replace.md"/>
             <toc-element topic="reverse.md"/>
             <toc-element topic="select.md"/>
-            <toc-element topic="shuffle.md"/>
             <toc-element topic="sliceRows.md"/>
             <toc-element topic="sortBy.md"/>
             <toc-element topic="split.md"/>
@@ -178,11 +179,22 @@
         <toc-element topic="columnOperations.md">
             <toc-element topic="columnArithmetics.md" toc-title="Arithmetics"/>
             <toc-element topic="columnStatistics.md" toc-title="Statistics"/>
+            <toc-element topic="asIterable.md"/>
+            <toc-element topic="asSequenceColumn.md" toc-title="asSequence"/>
+            <toc-element topic="between.md"/>
         </toc-element>
         <toc-element topic="ColumnSelectors.md"/>
+        <toc-element topic="Utils.md">
+            <toc-element topic="any.md"/>
+            <toc-element topic="all.md"/>
+            <toc-element topic="chunked.md"/>
+            <toc-element topic="shuffle.md"/>
+        </toc-element>
         <toc-element topic="collectionsInterop.md">
             <toc-element topic="toList.md"/>
             <toc-element topic="toMap.md"/>
+            <toc-element topic="associate.md"/>
+            <toc-element topic="associateBy.md"/>
         </toc-element>
         <toc-element topic="rendering.md">
             <toc-element topic="toHTML.md"/>