Skip to content

Commit 114ea71

Browse files
committed
readying examples and docs for Beta3
1 parent 35c9425 commit 114ea71

File tree

10 files changed

+45
-32
lines changed

10 files changed

+45
-32
lines changed

README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You could find the following articles there:
5454

5555
### What's new
5656

57-
1.0.0-Beta2: [Release notes](https://github.com/Kotlin/dataframe/releases/tag/v1.0.0-Beta2)
57+
1.0.0-Beta3: [Release notes](https://github.com/Kotlin/dataframe/releases/tag/v1.0.0-Beta3)
5858

5959
Check out this [notebook with new features](examples/notebooks/feature_overviews/0.15/new_features.ipynb) in v0.15.
6060

@@ -100,7 +100,7 @@ Add dependencies in the build.gradle.kts script:
100100

101101
```kotlin
102102
dependencies {
103-
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2")
103+
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta3")
104104
}
105105
```
106106

@@ -124,7 +124,7 @@ for Groovy, and for configurations specific to Android projects.
124124
This example of Kotlin DataFrame code with
125125
the [Compiler Plugin](https://kotlin.github.io/dataframe/compiler-plugin.html) enabled.
126126
See [the full project](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-example).
127-
See also
127+
See also
128128
[this example in Kotlin Notebook](https://github.com/Kotlin/dataframe/tree/master/examples/notebooks/readme_example.ipynb).
129129

130130
```kotlin
@@ -175,18 +175,19 @@ for your dataframes.
175175

176176
This table shows the mapping between main library component versions and minimum supported Java versions.
177177

178-
| Kotlin DataFrame Version | Minimum Java Version | Kotlin Version | Kotlin Jupyter Version | Apache Arrow version |
179-
|--------------------------|----------------------|----------------|------------------------|----------------------|
180-
| 0.10.0 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 |
181-
| 0.10.1 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 |
182-
| 0.11.0 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 |
183-
| 0.11.1 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 |
184-
| 0.12.0 | 8 | 1.9.0 | 0.11.0-358 | 11.0.0 |
185-
| 0.12.1 | 8 | 1.9.0 | 0.11.0-358 | 11.0.0 |
186-
| 0.13.1 | 8 | 1.9.22 | 0.12.0-139 | 15.0.0 |
187-
| 0.14.1 | 8 | 2.0.20 | 0.12.0-139 | 17.0.0 |
188-
| 0.15.0 | 8 | 2.0.20 | 0.12.0-139 | 18.1.0 |
189-
| 1.0.0-Beta2 | 8 / 11 | 2.0.20 | 0.12.0-383 | 18.1.0 |
178+
| Kotlin DataFrame Version | Minimum Java Version | Kotlin Version | Kotlin Jupyter Version | Apache Arrow Version | Compiler Plugin Version | Compatible Kandy version |
179+
|--------------------------|----------------------|----------------|------------------------|----------------------|-------------------------|--------------------------|
180+
| 0.10.0 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 | | |
181+
| 0.10.1 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 | | |
182+
| 0.11.0 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 | | |
183+
| 0.11.1 | 8 | 1.8.20 | 0.11.0-358 | 11.0.0 | | |
184+
| 0.12.0 | 8 | 1.9.0 | 0.11.0-358 | 11.0.0 | | |
185+
| 0.12.1 | 8 | 1.9.0 | 0.11.0-358 | 11.0.0 | | |
186+
| 0.13.1 | 8 | 1.9.22 | 0.12.0-139 | 15.0.0 | | |
187+
| 0.14.1 | 8 | 2.0.20 | 0.12.0-139 | 17.0.0 | | |
188+
| 0.15.0 | 8 | 2.0.20 | 0.12.0-139 | 18.1.0 | | 0.8.0 |
189+
| 1.0.0-Beta2 | 8 / 11 | 2.0.20 | 0.12.0-383 | 18.1.0 | 2.2.20-dev-3524 | 0.8.1-dev |
190+
| 1.0.0-Beta3 | 8 / 11 | 2.2.20 | 0.15.0-587 | 18.3.0 | 2.2.20 | TODO |
190191

191192
## Code of Conduct
192193

docs/StardustDocs/resources/guides/quickstart.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
},
5151
"cell_type": "code",
5252
"source": [
53-
"val df = DataFrame.readCSV(\n",
53+
"val df = DataFrame.readCsv(\n",
5454
" \"https://raw.githubusercontent.com/Kotlin/dataframe/master/data/jetbrains_repositories.csv\"\n",
5555
")"
5656
],

docs/StardustDocs/topics/setup/Modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ To enable the plugin in your Gradle project, add it to the `plugins` section:
512512

513513
```kotlin
514514
plugins {
515-
kotlin("plugin.dataframe") version "2.2.20-Beta1"
515+
kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%"
516516
}
517517
```
518518

@@ -522,7 +522,7 @@ plugins {
522522

523523
```groovy
524524
plugins {
525-
id 'org.jetbrains.kotlin.plugin.dataframe' version '2.2.20-Beta1'
525+
id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%'
526526
}
527527
```
528528

docs/StardustDocs/topics/setup/SetupAndroid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ To enable the plugin in your Gradle project, add it to the `plugins` section:
109109

110110
```kotlin
111111
plugins {
112-
kotlin("plugin.dataframe") version "2.2.20-Beta1"
112+
kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%"
113113
}
114114
```
115115

@@ -119,7 +119,7 @@ plugins {
119119

120120
```groovy
121121
plugins {
122-
id 'org.jetbrains.kotlin.plugin.dataframe' version '2.2.20-Beta1'
122+
id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%'
123123
}
124124
```
125125

docs/StardustDocs/topics/setup/SetupGradle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ To enable the plugin in your Gradle project, add it to the `plugins` section:
103103

104104
```kotlin
105105
plugins {
106-
kotlin("plugin.dataframe") version "2.2.20-Beta1"
106+
kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%"
107107
}
108108
```
109109

@@ -113,7 +113,7 @@ plugins {
113113

114114
```groovy
115115
plugins {
116-
id 'org.jetbrains.kotlin.plugin.dataframe' version '2.2.20-Beta1'
116+
id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%'
117117
}
118118
```
119119

docs/StardustDocs/topics/setup/SetupKotlinNotebook.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,13 @@ You can explicitly define the version you want:
7171
Or use the latest stable version of Kotlin DataFrame
7272
(specified in [Kotlin Jupyter descriptors](https://github.com/Kotlin/kotlin-jupyter-libraries)):
7373

74+
<warning>
75+
For version `1.0.0-Beta3`, in notebooks use version `1.0.0-Beta3n` instead.
76+
This uses the patch of [#1435](https://github.com/Kotlin/dataframe/pull/1435) for issue
77+
[#1116](https://github.com/Kotlin/dataframe/issues/1116), avoiding `DefinitelyNotNullable` errors.
78+
79+
When using `%use dataframe` this version is applied automatically.
80+
</warning>
7481

7582
```
7683
%useLatestDescriptors

docs/StardustDocs/v.list

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
33
<vars>
4-
<var name="dataFrameVersion" value="1.0.0-Beta2" type="string"/>
5-
<var name="compilerPluginKotlinVersion" value="2.2.20-Beta1" type="string"/>
4+
<var name="dataFrameVersion" value="1.0.0-Beta3" type="string"/>
5+
<var name="compilerPluginKotlinVersion" value="2.2.20" type="string"/>
66
</vars>

examples/android-example/app/build.gradle.kts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ plugins {
44
alias(libs.plugins.android.application)
55
alias(libs.plugins.kotlin.android)
66
alias(libs.plugins.kotlin.compose)
7-
kotlin("plugin.dataframe") version "2.2.20-Beta2"
7+
8+
// DataFrame Compiler plugin, matching the Kotlin version
9+
alias(libs.plugins.dataframe)
810
}
911

1012
android {
@@ -66,9 +68,9 @@ dependencies {
6668
// Core Kotlin DataFrame API, JSON and CSV IO.
6769
// See custom Gradle setup:
6870
// https://kotlin.github.io/dataframe/setupcustomgradle.html
69-
implementation("org.jetbrains.kotlinx:dataframe-core:1.0.0-dev-8314")
70-
implementation("org.jetbrains.kotlinx:dataframe-json:1.0.0-dev-8314")
71-
implementation("org.jetbrains.kotlinx:dataframe-csv:1.0.0-dev-8314")
71+
implementation("org.jetbrains.kotlinx:dataframe-core:1.0.0-Beta3")
72+
implementation("org.jetbrains.kotlinx:dataframe-json:1.0.0-Beta3")
73+
implementation("org.jetbrains.kotlinx:dataframe-csv:1.0.0-Beta3")
7274
// You can add any additional IO modules you like, except for 'dataframe-arrow'.
7375
// Apache Arrow is not supported well on Android.
7476
}

examples/android-example/gradle/libs.versions.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[versions]
22
agp = "8.11.1"
3-
kotlin = "2.2.20-Beta2"
3+
kotlin = "2.2.20"
44
coreKtx = "1.10.1"
55
junit = "4.13.2"
66
junitVersion = "1.1.5"
@@ -29,4 +29,5 @@ androidx-material3 = { group = "androidx.compose.material3", name = "material3"
2929
android-application = { id = "com.android.application", version.ref = "agp" }
3030
kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
3131
kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
32+
dataframe = { id = "org.jetbrains.kotlin.plugin.dataframe", version.ref = "kotlin" }
3233

examples/kotlin-dataframe-plugin-example/build.gradle.kts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ import org.jlleitschuh.gradle.ktlint.KtlintExtension
22

33
plugins {
44
id("org.jlleitschuh.gradle.ktlint") version "12.3.0"
5-
kotlin("jvm") version "2.2.20-Beta2"
6-
kotlin("plugin.dataframe") version "2.2.20-Beta2"
5+
6+
val kotlinVersion = "2.2.20"
7+
kotlin("jvm") version kotlinVersion
8+
kotlin("plugin.dataframe") version kotlinVersion
79
}
810

911
group = "org.example"
@@ -15,7 +17,7 @@ repositories {
1517
}
1618

1719
dependencies {
18-
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2")
20+
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta3")
1921
testImplementation(kotlin("test"))
2022
}
2123

0 commit comments

Comments
 (0)