Skip to content

format kdocs++ #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Aug 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataf
and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
by [Korro](https://github.com/devcrocod/korro).

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

Aside from code samples, `@TransformDataFrameExpressions` annotated test functions also generate sample
dataframe HTML files that can be used as iFrames on the documentation website.
Expand Down
64 changes: 35 additions & 29 deletions core/api/core.api
Original file line number Diff line number Diff line change
Expand Up @@ -2217,14 +2217,20 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormatClause {

public final class org/jetbrains/kotlinx/dataframe/api/FormatKt {
public static final fun and (Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Ljava/util/Collection;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/ranges/IntRange;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun at (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;[I)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun format (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun linearBg (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
public static final fun notNull (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun notNull (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
public static final fun perRowCol (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function3;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
public static final fun where (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;
public static final fun with (Lorg/jetbrains/kotlinx/dataframe/api/FormatClause;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;
Expand All @@ -2240,26 +2246,26 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormattedFrame {
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;
}

public final class org/jetbrains/kotlinx/dataframe/api/FormattingDSL {
public static final field INSTANCE Lorg/jetbrains/kotlinx/dataframe/api/FormattingDSL;
public final class org/jetbrains/kotlinx/dataframe/api/FormattingDsl {
public static final field INSTANCE Lorg/jetbrains/kotlinx/dataframe/api/FormattingDsl;
public final fun attr (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun background (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun background (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun background (SSS)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun getBlack ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getBlue ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getBlack ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getBlue ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getBold ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun getDarkGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getGreen ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getDarkGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getGreen ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getItalic ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun getLightGray ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getRed ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getLightGray ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getRed ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun getUnderline ()Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun getWhite ()Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun linear (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun getWhite ()Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun linear (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun linearBg (Ljava/lang/Number;Lkotlin/Pair;Lkotlin/Pair;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun rgb (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public final fun textColor (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun rgb (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public final fun textColor (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
public final fun textColor (SSS)Lorg/jetbrains/kotlinx/dataframe/api/CellAttributes;
}

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

public final class org/jetbrains/kotlinx/dataframe/api/RGBColor {
public fun <init> (SSS)V
public final fun component1 ()S
public final fun component2 ()S
public final fun component3 ()S
public final fun copy (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public static synthetic fun copy$default (Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;SSSILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/api/RGBColor;
public fun equals (Ljava/lang/Object;)Z
public final fun getB ()S
public final fun getG ()S
public final fun getR ()S
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class org/jetbrains/kotlinx/dataframe/api/ReducedGroupBy {
public fun <init> (Lorg/jetbrains/kotlinx/dataframe/api/GroupBy;Lkotlin/jvm/functions/Function2;)V
public final fun getGroupBy ()Lorg/jetbrains/kotlinx/dataframe/api/GroupBy;
Expand Down Expand Up @@ -3922,6 +3913,21 @@ public final class org/jetbrains/kotlinx/dataframe/api/ReverseKt {
public static final fun reverse (Lorg/jetbrains/kotlinx/dataframe/columns/ValueColumn;)Lorg/jetbrains/kotlinx/dataframe/columns/ValueColumn;
}

public final class org/jetbrains/kotlinx/dataframe/api/RgbColor {
public fun <init> (SSS)V
public final fun component1 ()S
public final fun component2 ()S
public final fun component3 ()S
public final fun copy (SSS)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public static synthetic fun copy$default (Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;SSSILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/api/RgbColor;
public fun equals (Ljava/lang/Object;)Z
public final fun getB ()S
public final fun getG ()S
public final fun getR ()S
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class org/jetbrains/kotlinx/dataframe/api/SchemaKt {
public static final fun schema (Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;
public static final fun schema (Lorg/jetbrains/kotlinx/dataframe/DataRow;)Lorg/jetbrains/kotlinx/dataframe/schema/DataFrameSchema;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ internal interface FillNulls {
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
*
* &nbsp;&nbsp;&nbsp;&nbsp;
Expand Down Expand Up @@ -389,6 +392,9 @@ internal interface FillNaNs {
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
*
* &nbsp;&nbsp;&nbsp;&nbsp;
Expand Down Expand Up @@ -662,6 +668,9 @@ internal interface FillNA {
* `[ `__`.`__[**`at`**][org.jetbrains.kotlinx.dataframe.api.Update.at]**`(`**[`rowIndices`][org.jetbrains.kotlinx.dataframe.api.CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* `[ `__`.`__[**`notNull`**][org.jetbrains.kotlinx.dataframe.api.Update.notNull]**`()`**` ]`
*
* &nbsp;&nbsp;&nbsp;&nbsp;
* __`.`__[**`with`**][org.jetbrains.kotlinx.dataframe.api.Update.with]**` { `**[`rowExpression`][org.jetbrains.kotlinx.dataframe.documentation.ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
*
* &nbsp;&nbsp;&nbsp;&nbsp;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ public inline fun <T, C, R> Convert<T, C>.asColumn(
* ```kotlin
* // Convert values in all columns to `String` and add their column name to the end
* df.convert { all() }.perRowCol { row, col ->
* row[col].toString() + col.name()
* col[row].toString() + col.name()
* }
* ```
*
Expand Down
Loading