Skip to content

Commit cd181a6

Browse files
fix group grammar
1 parent 5bc9783 commit cd181a6

File tree

1 file changed

+6
-1
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+6
-1
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/group.kt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,11 @@ internal interface GroupDocs {
6767
* __`.`__[**`into`**][GroupClause.into]**`(`**`groupName: `[`String`][String]**`)`**
6868
*
6969
* {@include [Indent]}
70-
* __`.`__[**`into`**][GroupClause.into]**` { `**`groupNameExpression: `[`ColumnsSelector`][ColumnsSelector]**` } `**
70+
* __`.`__[**`into`**][GroupClause.into]` { column: `[`ColumnsSelectionDsl<T>`][ColumnsSelectionDsl]`.(`[`ColumnWithPath<C>`][ColumnWithPath]`) -> `[`String`][String]` }`
71+
*
72+
* {@include [Indent]}
73+
* __`.`__[**`into`**][GroupClause.into]` { column: `[`ColumnsSelectionDsl<T>`][ColumnsSelectionDsl]`.(`[`ColumnWithPath<C>`][ColumnWithPath]`) -> `[`AnyColumnReference`][AnyColumnReference]` }`
74+
*
7175
*/
7276
interface Grammar
7377
}
@@ -156,6 +160,7 @@ public class GroupClause<T, C>(internal val df: DataFrame<T>, internal val colum
156160
*
157161
* ### Example:
158162
* ```kotlin
163+
* // For each selected column, place it under its under a group with its type as name (individual for each column):
159164
* df.group { all() }.into { it.type().toString() }
160165
* ```
161166
*

0 commit comments

Comments
 (0)