Skip to content

Commit 9aa6030

Browse files
committed
tiny readme fixes, updated samples/api tests and ran korro for the docs
1 parent 9fefe06 commit 9aa6030

File tree

8 files changed

+21
-20
lines changed

8 files changed

+21
-20
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Kotlin Dataframe: typesafe in-memory structured data processing for JVM
22
[![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
33
[![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)
4-
[![Kotlin](https://img.shields.io/badge/kotlin-1.8.20-blue.svg?logo=kotlin)](http://kotlinlang.org)
4+
[![Kotlin](https://img.shields.io/badge/kotlin-1.9.22-blue.svg?logo=kotlin)](http://kotlinlang.org)
55
[![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)
66
[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
77
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Kotlin/dataframe/HEAD)

RELEASE_CHECK_LIST.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,17 @@
2323
- Check on Datalore with a test project (TODO: add link).
2424
- Check for Android with a test project (TODO: add link).
2525
- Check for ServerSide with a test project (TODO: add link).
26-
15. Publish Documentation from [GitHub Action](https://github.com/Kotlin/dataframe/actions/workflows/main.yml)
27-
16. Prepare and publish the Release Notes. **RC**
28-
17. Create a Release from the release tag on GitHub. **RC**
29-
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.
30-
19. Update the DataFrame version in the `gradle.properties` file for the next release cycle (i.e. 0.10.0 -> 0.11.0)
31-
20. Update deprecated functions in [deprecationMessages.kt](/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt)
26+
15. Run `./gradlew korro` to update the code snippets for the docs.
27+
16. Publish Documentation from [GitHub Action](https://github.com/Kotlin/dataframe/actions/workflows/main.yml)
28+
17. Prepare and publish the Release Notes. **RC**
29+
18. Create a Release from the release tag on GitHub. **RC**
30+
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.
31+
20. Update the DataFrame version in the `gradle.properties` file for the next release cycle (i.e. 0.10.0 -> 0.11.0)
32+
21. Update deprecated functions in [deprecationMessages.kt](/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt)
3233
such that
3334
- `Level.WARNING` messages are changed to `Level.ERROR`
3435
- `Level.ERROR` messages and their functions are removed.
3536
- Update regions in the file accordingly.
36-
21. Update Notebook examples, both in the project and on Datalore.
37+
22. Update Notebook examples, both in the project and on Datalore.
3738

3839
(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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -874,7 +874,7 @@ class Access : TestBase() {
874874
// SampleStart
875875
// by condition
876876
df.select { cols { it.name().startsWith("year") } }
877-
df.select { startsWith("year") }
877+
df.select { nameStartsWith("year") }
878878

879879
// by type
880880
df.select { colsOf<String>() }
@@ -919,7 +919,7 @@ class Access : TestBase() {
919919
df.select { colsAtAnyDepth().colsOf<String>() }
920920

921921
// all columns except given column set
922-
df.select { except { colsOf<String>() } }
922+
df.select { allExcept { colsOf<String>() } }
923923

924924
// union of column sets
925925
df.select { take(2) and col(3) }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ class ApiLevels {
112112
)
113113

114114
val passengers = DataFrame.read("titanic.csv")
115-
.filter { it.get(Passenger::city).endsWith("NY") }
115+
.filter { it[Passenger::city].endsWith("NY") }
116116
.toListOf<Passenger>()
117117
// SampleEnd
118118
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ class JoinWith : TestBase() {
104104
}
105105
}
106106

107-
private fun AnyFrame.uwrapColoredValues(): AnyFrame {
107+
private fun AnyFrame.unwrapColoredValues(): AnyFrame {
108108
return convert { colsAtAnyDepth().colsOf<ColoredValue<*>?>() }.with(Infer.Type) { it?.value }
109109
}
110110

@@ -171,9 +171,9 @@ class JoinWith : TestBase() {
171171
}
172172

173173
private fun snippetOutput(coloredResult: DataFrame<Any?>, result: DataFrame<Any?>) {
174-
coloredCampaigns.uwrapColoredValues() shouldBe campaigns
175-
coloredVisits.uwrapColoredValues() shouldBe visits
176-
coloredResult.uwrapColoredValues() shouldBe result
174+
coloredCampaigns.unwrapColoredValues() shouldBe campaigns
175+
coloredVisits.unwrapColoredValues() shouldBe visits
176+
coloredResult.unwrapColoredValues() shouldBe result
177177

178178
PluginCallbackProxy.overrideHtmlOutput(
179179
manualOutput = DataFrameHtmlData.tableDefinitions()

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@
209209
</details>
210210
<br>
211211
<details>
212-
<summary>df.select { startsWith(&quot;year&quot;) }</summary>
212+
<summary>df.select { nameStartsWith(&quot;year&quot;) }</summary>
213213
<details>
214214
<summary>Input DataFrame: rowsCount = 7, columnsCount = 6</summary>
215215
<table class="dataframe" id="df_4"></table>
@@ -453,7 +453,7 @@
453453
</details>
454454
<br>
455455
<details>
456-
<summary>df.select { except { colsOf&amp;lt;String&amp;gt;() } }</summary>
456+
<summary>df.select { allExcept { colsOf&amp;lt;String&amp;gt;() } }</summary>
457457
<details>
458458
<summary>Input DataFrame: rowsCount = 7, columnsCount = 6</summary>
459459
<table class="dataframe" id="df_34"></table>

docs/StardustDocs/topics/ColumnSelectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ df.select { cols(1..4) }
155155
```kotlin
156156
// by condition
157157
df.select { cols { it.name().startsWith("year") } }
158-
df.select { startsWith("year") }
158+
df.select { nameStartsWith("year") }
159159

160160
// by type
161161
df.select { colsOf<String>() }
@@ -200,7 +200,7 @@ df.select { colsAtAnyDepth { it.name().contains(":") } }
200200
df.select { colsAtAnyDepth().colsOf<String>() }
201201

202202
// all columns except given column set
203-
df.select { except { colsOf<String>() } }
203+
df.select { allExcept { colsOf<String>() } }
204204

205205
// union of column sets
206206
df.select { take(2) and col(3) }

docs/StardustDocs/topics/KPropertiesApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ data class Passenger(
4343
)
4444

4545
val passengers = DataFrame.read("titanic.csv")
46-
.filter { it.get(Passenger::city).endsWith("NY") }
46+
.filter { it[Passenger::city].endsWith("NY") }
4747
.toListOf<Passenger>()
4848
```
4949

0 commit comments

Comments
 (0)