Merge pull request #629 from Kotlin/0.13.1-docs

Update docs and readme for 0.13.1

Author: Jolanrensen

.github/workflows/main.yml

@@ -17,7 +17,7 @@ env:
   ALGOLIA_INDEX_NAME: prod_DATAFRAME_HELP
   ALGOLIA_KEY: ${{ secrets.ALGOLIA_KEY }}
   CONFIG_JSON_PRODUCT: Dataframe
-  CONFIG_JSON_VERSION: '0.12'
+  CONFIG_JSON_VERSION: '0.13'
 
 jobs:
   build-job:

README.md

@@ -1,7 +1,7 @@
 # Kotlin Dataframe: typesafe in-memory structured data processing for JVM
 [![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![Kotlin component alpha stability](https://img.shields.io/badge/project-alpha-kotlin.svg?colorA=555555&colorB=DB3683&label=&logo=kotlin&logoColor=ffffff&logoWidth=10)](https://kotlinlang.org/docs/components-stability.html)
-[![Kotlin](https://img.shields.io/badge/kotlin-1.8.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
+[![Kotlin](https://img.shields.io/badge/kotlin-1.9.22-blue.svg?logo=kotlin)](http://kotlinlang.org)
 [![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/dataframe?color=blue&label=Maven%20Central)](https://search.maven.org/artifact/org.jetbrains.kotlinx/dataframe)
 [![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Kotlin/dataframe/HEAD)
@@ -38,13 +38,13 @@ You could find the following articles there:
 ## Setup
 
 ```kotlin
-implementation("org.jetbrains.kotlinx:dataframe:0.12.1")
+implementation("org.jetbrains.kotlinx:dataframe:0.13.1")
 ```
 
 Optional Gradle plugin for enhanced type safety and schema generation
 https://kotlin.github.io/dataframe/schemasgradle.html
 ```kotlin
-id("org.jetbrains.kotlinx.dataframe") version "0.12.1"
+id("org.jetbrains.kotlinx.dataframe") version "0.13.1"
 ```
 
 Check out the [custom setup page](https://kotlin.github.io/dataframe/gettingstartedgradleadvanced.html) if you don't need some of the formats as dependencies,
@@ -69,7 +69,7 @@ df.filter { "stargazers_count"<Int>() > 50 }.print()
 
 Requires Gradle plugin to work
 ```kotlin
-id("org.jetbrains.kotlinx.dataframe") version "0.12.1"
+id("org.jetbrains.kotlinx.dataframe") version "0.13.1"
 ```
 
 Plugin generates extension properties API for provided sample of data. Column names and their types become discoverable in completion.
@@ -219,7 +219,7 @@ This table shows the mapping between main library component versions and minimum
 | 0.11.1                   | 8                    | 1.8.20         | 0.11.0-358             | 3.0.0           | 11.0.0               |
 | 0.12.0                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
 | 0.12.1                   | 8                    | 1.9.0          | 0.11.0-358             | 3.0.0           | 11.0.0               |
-
+| 0.13.1                   | 8                    | 1.9.22         | 0.12.0-139             | 3.0.0           | 15.0.0               |
 
 ## Code of Conduct
 

RELEASE_CHECK_LIST.md

@@ -23,16 +23,17 @@
     - Check on Datalore with a test project (TODO: add link).
     - Check for Android with a test project (TODO: add link).
     - Check for ServerSide with a test project (TODO: add link).
-15. Publish Documentation from [GitHub Action](https://github.com/Kotlin/dataframe/actions/workflows/main.yml)
-16. Prepare and publish the Release Notes. **RC**
-17. Create a Release from the release tag on GitHub. **RC**
-18. Update a KDF version in the [Kotlin Jupyter Descriptor](https://github.com/Kotlin/kotlin-jupyter-libraries/blob/master/dataframe.json). Now the Renovate bot does this.
-19. Update the DataFrame version in the `gradle.properties` file for the next release cycle (i.e. 0.10.0 -> 0.11.0)
-20. Update deprecated functions in [deprecationMessages.kt](/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt)
+15. Run `./gradlew korro` to update the code snippets for the docs.
+16. Publish Documentation from [GitHub Action](https://github.com/Kotlin/dataframe/actions/workflows/main.yml)
+17. Prepare and publish the Release Notes. **RC**
+18. Create a Release from the release tag on GitHub. **RC**
+19. Update a KDF version in the [Kotlin Jupyter Descriptor](https://github.com/Kotlin/kotlin-jupyter-libraries/blob/master/dataframe.json). Now the Renovate bot does this.
+20. Update the DataFrame version in the `gradle.properties` file for the next release cycle (i.e. 0.10.0 -> 0.11.0)
+21. Update deprecated functions in [deprecationMessages.kt](/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt)
     such that 
     - `Level.WARNING` messages are changed to `Level.ERROR`
     - `Level.ERROR` messages and their functions are removed.
     - Update regions in the file accordingly.
-21. Update Notebook examples, both in the project and on Datalore.
+22. Update Notebook examples, both in the project and on Datalore.
 
 (Activities that need to be done for **R**elease **C**andidate releases are marked as such)

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Access.kt

@@ -874,7 +874,7 @@ class Access : TestBase() {
         // SampleStart
         // by condition
         df.select { cols { it.name().startsWith("year") } }
-        df.select { startsWith("year") }
+        df.select { nameStartsWith("year") }
 
         // by type
         df.select { colsOf<String>() }
@@ -919,7 +919,7 @@ class Access : TestBase() {
         df.select { colsAtAnyDepth().colsOf<String>() }
 
         // all columns except given column set
-        df.select { except { colsOf<String>() } }
+        df.select { allExcept { colsOf<String>() } }
 
         // union of column sets
         df.select { take(2) and col(3) }

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/ApiLevels.kt

@@ -112,7 +112,7 @@ class ApiLevels {
         )
 
         val passengers = DataFrame.read("titanic.csv")
-            .filter { it.get(Passenger::city).endsWith("NY") }
+            .filter { it[Passenger::city].endsWith("NY") }
             .toListOf<Passenger>()
         // SampleEnd
     }

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/JoinWith.kt

@@ -104,7 +104,7 @@ class JoinWith : TestBase() {
         }
     }
 
-    private fun AnyFrame.uwrapColoredValues(): AnyFrame {
+    private fun AnyFrame.unwrapColoredValues(): AnyFrame {
         return convert { colsAtAnyDepth().colsOf<ColoredValue<*>?>() }.with(Infer.Type) { it?.value }
     }
 
@@ -171,9 +171,9 @@ class JoinWith : TestBase() {
     }
 
     private fun snippetOutput(coloredResult: DataFrame<Any?>, result: DataFrame<Any?>) {
-        coloredCampaigns.uwrapColoredValues() shouldBe campaigns
-        coloredVisits.uwrapColoredValues() shouldBe visits
-        coloredResult.uwrapColoredValues() shouldBe result
+        coloredCampaigns.unwrapColoredValues() shouldBe campaigns
+        coloredVisits.unwrapColoredValues() shouldBe visits
+        coloredResult.unwrapColoredValues() shouldBe result
 
         PluginCallbackProxy.overrideHtmlOutput(
             manualOutput = DataFrameHtmlData.tableDefinitions()

docs/StardustDocs/project.ihp

@@ -4,10 +4,10 @@
 <ihp version="2.0">
     <categories src="c.list"/>
     <topics dir="topics"/>
-    <images dir="images" version="0.12" web-path="images/" />
-    <snippets dir="snippets" version="0.12" web-path="snippets/" />
+    <images dir="images" version="0.13" web-path="images/" />
+    <snippets dir="snippets" version="0.13" web-path="snippets/" />
     <vars src="v.list"/>
-    <instance src="d.tree" version="0.12" id="dataframe"/>
+    <instance src="d.tree" version="0.13" id="dataframe"/>
     <settings>
         <default-property element-name="chapter" property-name="show-structure-depth" value="2"/>
     </settings>

docs/StardustDocs/snippets/org.jetbrains.kotlinx.dataframe.samples.api.Access.columnSelectorsMisc.html

@@ -209,7 +209,7 @@
                             </details>
                             <br>
                             <details>
-                            <summary>df.select { startsWith(&quot;year&quot;) }</summary>
+                            <summary>df.select { nameStartsWith(&quot;year&quot;) }</summary>
                                                                 <details>
                                     <summary>Input DataFrame: rowsCount = 7, columnsCount = 6</summary>
                                      <table class="dataframe" id="df_4"></table>
@@ -453,7 +453,7 @@
                             </details>
                             <br>
                             <details>
-                            <summary>df.select { except { colsOf&amp;lt;String&amp;gt;() } }</summary>
+                            <summary>df.select { allExcept { colsOf&amp;lt;String&amp;gt;() } }</summary>
                                                                 <details>
                                     <summary>Input DataFrame: rowsCount = 7, columnsCount = 6</summary>
                                      <table class="dataframe" id="df_34"></table>

docs/StardustDocs/topics/ColumnSelectors.md

@@ -155,7 +155,7 @@ df.select { cols(1..4) }
 ```kotlin
 // by condition
 df.select { cols { it.name().startsWith("year") } }
-df.select { startsWith("year") }
+df.select { nameStartsWith("year") }
 
 // by type
 df.select { colsOf<String>() }
@@ -200,7 +200,7 @@ df.select { colsAtAnyDepth { it.name().contains(":") } }
 df.select { colsAtAnyDepth().colsOf<String>() }
 
 // all columns except given column set
-df.select { except { colsOf<String>() } }
+df.select { allExcept { colsOf<String>() } }
 
 // union of column sets
 df.select { take(2) and col(3) }

docs/StardustDocs/topics/KPropertiesApi.md

@@ -43,7 +43,7 @@ data class Passenger(
 )
 
 val passengers = DataFrame.read("titanic.csv")
-    .filter { it.get(Passenger::city).endsWith("NY") }
+    .filter { it[Passenger::city].endsWith("NY") }
     .toListOf<Passenger>()
 ```