Skip to content

Commit 03ab7b1

Browse files
JolanrensenJolanrensen
committed
Continuing format docs for the website, using new sample dataframes in the tests module. Updated references to format 
1 parent e92a8f6 commit 03ab7b1

File tree

15 files changed

+1384
-359
lines changed

15 files changed

+1384
-359
lines changed

‎core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataf
1818
and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
1919
by [Korro](https://github.com/devcrocod/korro).
2020

21-
### Explainer dataframes
21+
### ~~Explainer dataframes~~ NOTE: This is being moved to [tests](../tests)
2222

2323
Aside from code samples, `@TransformDataFrameExpressions` annotated test functions also generate sample
2424
dataframe HTML files that can be used as iFrames on the documentation website.

‎core/api/core.api

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2217,14 +2217,20 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormatClause {
22172217

22182218
public final class org/jetbrains/kotlinx/dataframe/api/FormatKt {
22192219
public static final fun and (Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2220+
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Ljava/util/Collection;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
2221+
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/ranges/IntRange;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
2222+
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;[I)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22202223
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22212224
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22222225
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22232226
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22242227
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22252228
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22262229
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
2230+
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22272231
public static final fun linearBg (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
2232+
public static final fun notNull (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
2233+
public static final fun notNull (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
22282234
public static final fun perRowCol (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function3;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
22292235
public static final fun where (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
22302236
public static final fun with (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
@@ -2240,26 +2246,26 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormattedFrame {
22402246
public static synthetic fun toStandaloneHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
22412247
}
22422248

2243-
public final class org/jetbrains/kotlinx/dataframe/api/FormattingDSL {
2244-
public static final field INSTANCE Lorg/jetbrains/kotlinx/dataframe/api/FormattingDSL;
2249+
public final class org/jetbrains/kotlinx/dataframe/api/FormattingDsl {
2250+
public static final field INSTANCE Lorg/jetbrains/kotlinx/dataframe/api/FormattingDsl;
22452251
public final fun attr (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2246-
public final fun background (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2252+
public final fun background (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
22472253
public final fun background (SSS)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2248-
public final fun getBlack ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2249-
public final fun getBlue ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2254+
public final fun getBlack ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2255+
public final fun getBlue ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
22502256
public final fun getBold ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2251-
public final fun getDarkGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2252-
public final fun getGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2253-
public final fun getGreen ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2257+
public final fun getDarkGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2258+
public final fun getGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2259+
public final fun getGreen ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
22542260
public final fun getItalic ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2255-
public final fun getLightGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2256-
public final fun getRed ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2261+
public final fun getLightGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2262+
public final fun getRed ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
22572263
public final fun getUnderline ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2258-
public final fun getWhite ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2259-
public final fun linear (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2264+
public final fun getWhite ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2265+
public final fun linear (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
22602266
public final fun linearBg (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2261-
public final fun rgb (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
2262-
public final fun textColor (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
2267+
public final fun rgb (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
2268+
public final fun textColor (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
22632269
public final fun textColor (SSS)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
22642270
}
22652271

@@ -3764,21 +3770,6 @@ public final class org/jetbrains/kotlinx/dataframe/api/PrintKt {
37643770
public static final fun print-XIlnkTk (Ljava/lang/String;)V
37653771
}
37663772

3767-
public final class org/jetbrains/kotlinx/dataframe/api/RGBColor {
3768-
public fun <init> (SSS)V
3769-
public final fun component1 ()S
3770-
public final fun component2 ()S
3771-
public final fun component3 ()S
3772-
public final fun copy (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
3773-
public static synthetic fun copy$default (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;SSSILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
3774-
public fun equals (Ljava/lang/Object;)Z
3775-
public final fun getB ()S
3776-
public final fun getG ()S
3777-
public final fun getR ()S
3778-
public fun hashCode ()I
3779-
public fun toString ()Ljava/lang/String;
3780-
}
3781-
37823773
public final class org/jetbrains/kotlinx/dataframe/api/ReducedGroupBy {
37833774
public fun <init> (Lorg/jetbrains/kotlinx/dataframe/api/GroupBy;Lkotlin/jvm/functions/Function2;)V
37843775
public final fun getGroupBy ()Lorg/jetbrains/kotlinx/dataframe/api/GroupBy;
@@ -3922,6 +3913,21 @@ public final class org/jetbrains/kotlinx/dataframe/api/ReverseKt {
39223913
public static final fun reverse (Lorg/jetbrains/kotlinx/dataframe/columns/ValueColumn;)Lorg/jetbrains/kotlinx/dataframe/columns/ValueColumn;
39233914
}
39243915

3916+
public final class org/jetbrains/kotlinx/dataframe/api/RgbColor {
3917+
public fun <init> (SSS)V
3918+
public final fun component1 ()S
3919+
public final fun component2 ()S
3920+
public final fun component3 ()S
3921+
public final fun copy (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
3922+
public static synthetic fun copy$default (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;SSSILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
3923+
public fun equals (Ljava/lang/Object;)Z
3924+
public final fun getB ()S
3925+
public final fun getG ()S
3926+
public final fun getR ()S
3927+
public fun hashCode ()I
3928+
public fun toString ()Ljava/lang/String;
3929+
}
3930+
39253931
public final class org/jetbrains/kotlinx/dataframe/api/SchemaKt {
39263932
public static final fun schema (Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;
39273933
public static final fun schema (Lorg/jetbrains/kotlinx/dataframe/DataRow;)Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;

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

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@
33
package org.jetbrains.kotlinx.dataframe.samples.api
44

55
import io.kotest.matchers.shouldBe
6-
import org.jetbrains.kotlinx.dataframe.DataColumn
76
import org.jetbrains.kotlinx.dataframe.DataFrame
87
import org.jetbrains.kotlinx.dataframe.DataRow
98
import org.jetbrains.kotlinx.dataframe.alsoDebug
109
import org.jetbrains.kotlinx.dataframe.annotations.DataSchema
11-
import org.jetbrains.kotlinx.dataframe.api.FormattingDsl
1210
import org.jetbrains.kotlinx.dataframe.api.ParserOptions
1311
import org.jetbrains.kotlinx.dataframe.api.add
1412
import org.jetbrains.kotlinx.dataframe.api.after
@@ -39,7 +37,6 @@ import org.jetbrains.kotlinx.dataframe.api.fillNaNs
3937
import org.jetbrains.kotlinx.dataframe.api.fillNulls
4038
import org.jetbrains.kotlinx.dataframe.api.filter
4139
import org.jetbrains.kotlinx.dataframe.api.flatten
42-
import org.jetbrains.kotlinx.dataframe.api.format
4340
import org.jetbrains.kotlinx.dataframe.api.gather
4441
import org.jetbrains.kotlinx.dataframe.api.getRows
4542
import org.jetbrains.kotlinx.dataframe.api.group
@@ -55,7 +52,6 @@ import org.jetbrains.kotlinx.dataframe.api.intoRows
5552
import org.jetbrains.kotlinx.dataframe.api.inward
5653
import org.jetbrains.kotlinx.dataframe.api.keysInto
5754
import org.jetbrains.kotlinx.dataframe.api.length
58-
import org.jetbrains.kotlinx.dataframe.api.linearBg
5955
import org.jetbrains.kotlinx.dataframe.api.lowercase
6056
import org.jetbrains.kotlinx.dataframe.api.map
6157
import org.jetbrains.kotlinx.dataframe.api.mapKeys
@@ -67,7 +63,6 @@ import org.jetbrains.kotlinx.dataframe.api.max
6763
import org.jetbrains.kotlinx.dataframe.api.mean
6864
import org.jetbrains.kotlinx.dataframe.api.meanFor
6965
import org.jetbrains.kotlinx.dataframe.api.merge
70-
import org.jetbrains.kotlinx.dataframe.api.min
7166
import org.jetbrains.kotlinx.dataframe.api.minus
7267
import org.jetbrains.kotlinx.dataframe.api.move
7368
import org.jetbrains.kotlinx.dataframe.api.named
@@ -1309,38 +1304,4 @@ class Modify : TestBase() {
13091304
}
13101305
// SampleEnd
13111306
}
1312-
1313-
@Test
1314-
fun formatExample_properties() {
1315-
// SampleStart
1316-
df
1317-
.format().with { bold and textColor(black) }
1318-
.format { isHappy }.with { background(if (it) green else red) }
1319-
.format { weight }.notNull().linearBg(50 to FormattingDsl.blue, 90 to FormattingDsl.red)
1320-
.format { age }.perRowCol { row, col ->
1321-
textColor(
1322-
linear(value = col[row], from = col.min() to blue, to = col.max() to green)
1323-
)
1324-
}
1325-
.toStandaloneHtml()
1326-
// SampleEnd
1327-
}
1328-
1329-
@Suppress("UNCHECKED_CAST")
1330-
@Test
1331-
fun formatExample_strings() {
1332-
// SampleStart
1333-
df
1334-
.format().with { bold and textColor(black) }
1335-
.format("isHappy").with { background(if (it as Boolean) green else red) }
1336-
.format("weight").notNull().with { linearBg(it as Int, 50 to blue, 90 to red) }
1337-
.format("age").perRowCol { row, col ->
1338-
col as DataColumn<Int>
1339-
textColor(
1340-
linear(value = col[row], from = col.min() to blue, to = col.max() to green)
1341-
)
1342-
}
1343-
.toStandaloneHtml()
1344-
// SampleEnd
1345-
}
13461307
}

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

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@ package org.jetbrains.kotlinx.dataframe.samples.api
22

33
import org.jetbrains.kotlinx.dataframe.AnyFrame
44
import org.jetbrains.kotlinx.dataframe.DataFrame
5-
import org.jetbrains.kotlinx.dataframe.api.*
6-
import org.jetbrains.kotlinx.dataframe.api.FormattedFrame
75
import org.jetbrains.kotlinx.dataframe.api.take
86
import org.jetbrains.kotlinx.dataframe.explainer.WritersideFooter
97
import org.jetbrains.kotlinx.dataframe.explainer.WritersideStyle
10-
import org.jetbrains.kotlinx.dataframe.io.DisplayConfiguration
118
import org.jetbrains.kotlinx.dataframe.io.read
129
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHtml
1310
import org.junit.Test
1411
import java.io.File
1512

1613
// To display code together with a table, we can use TransformDataFrameExpressions annotation together with korro
1714
// This class provides an ability to save only a table that can be embedded anywhere in the documentation
15+
16+
@Deprecated("This can now be reproduced with 'sample dataframes' in the 'tests' module.")
1817
class OtherSamples : TestBase() {
1918

2019
@Test
@@ -23,33 +22,9 @@ class OtherSamples : TestBase() {
2322
// writeTable(df, "exampleName")
2423
}
2524

26-
@Test
27-
fun formatExample() {
28-
val formattedDf = df
29-
.format().with { bold and textColor(black) }
30-
.format { isHappy }.with { background(if (it) green else red) }
31-
.format { weight }.notNull().linearBg(50 to FormattingDsl.blue, 90 to FormattingDsl.red)
32-
.format { age }.perRowCol { row, col ->
33-
textColor(
34-
linear(value = col[row], from = col.min() to blue, to = col.max() to green),
35-
)
36-
}
37-
38-
writeTable(formattedDf, "formatExample")
39-
}
40-
4125
private fun writeTable(df: AnyFrame, name: String) {
4226
val dir = File("../docs/StardustDocs/resources/snippets/manual").also { it.mkdirs() }
4327
val html = df.toStandaloneHtml(getFooter = WritersideFooter) + WritersideStyle
4428
html.writeHtml(File(dir, "$name.html"))
4529
}
46-
47-
private fun writeTable(formattedDf: FormattedFrame<*>, name: String) {
48-
val dir = File("../docs/StardustDocs/resources/snippets/manual").also { it.mkdirs() }
49-
val html = formattedDf.df.toStandaloneHtml(
50-
configuration = formattedDf.getDisplayConfiguration(DisplayConfiguration.DEFAULT),
51-
getFooter = WritersideFooter,
52-
) + WritersideStyle
53-
html.writeHtml(File(dir, "$name.html"))
54-
}
5530
}

0 commit comments

Comments
 (0)