Skip to content

Commit 1ca44b5

Browse files
JolanrensenJolanrensen
authored
Merge pull request #1346 from Kotlin/format-docs
`format` kdocs++
2 parents 37540a8 + a384ad0 commit 1ca44b5

File tree

49 files changed

+4736
-590
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+4736
-590
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/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ internal interface FillNulls {
5555
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
5656
*
5757
* &nbsp;&nbsp;&nbsp;&nbsp;
58+
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
59+
*
60+
* &nbsp;&nbsp;&nbsp;&nbsp;
5861
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
5962
*
6063
* &nbsp;&nbsp;&nbsp;&nbsp;
@@ -389,6 +392,9 @@ internal interface FillNaNs {
389392
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
390393
*
391394
* &nbsp;&nbsp;&nbsp;&nbsp;
395+
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
396+
*
397+
* &nbsp;&nbsp;&nbsp;&nbsp;
392398
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
393399
*
394400
* &nbsp;&nbsp;&nbsp;&nbsp;
@@ -662,6 +668,9 @@ internal interface FillNA {
662668
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
663669
*
664670
* &nbsp;&nbsp;&nbsp;&nbsp;
671+
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
672+
*
673+
* &nbsp;&nbsp;&nbsp;&nbsp;
665674
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
666675
*
667676
* &nbsp;&nbsp;&nbsp;&nbsp;

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/convert.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ public inline fun <T, C, R> Convert<T, C>.asColumn(
651651
* ```kotlin
652652
* // Convert values in all columns to `String` and add their column name to the end
653653
* df.convert { all() }.perRowCol { row, col ->
654-
* row[col].toString() + col.name()
654+
* col[row].toString() + col.name()
655655
* }
656656
* ```
657657
*

0 commit comments

Comments
 (0)