Skip to content

Commit 55d913e

Browse files
committed
pivot.kt kdoc fixes
1 parent 06f123b commit 55d913e

File tree

1 file changed

+25
-16
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+25
-16
lines changed

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

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -486,8 +486,9 @@ internal interface DataFramePivotMatchesCommonDocs
486486

487487
/**
488488
* @include [DataFramePivotMatchesCommonDocs]
489-
* @include [SelectingColumns.Dsl]
489+
* Select or express pivot columns using the [PivotDsl].
490490
*
491+
* @include [PivotDslDocs]
491492
* ### Example
492493
* ```kotlin
493494
* // Compute whether matching rows exist for all unique values of "city"
@@ -498,7 +499,7 @@ internal interface DataFramePivotMatchesCommonDocs
498499
*
499500
* @param [inward] If `true` (default), the generated pivoted columns are nested inside the original column;
500501
* if `false`, they are placed at the top level.
501-
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used as [pivot] keys for the operation.
502+
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used as [pivot] keys for the operation.
502503
* @return A new [DataFrame] representing a [Boolean] presence matrix — with grouping key columns as rows,
503504
* pivot key values as columns, and `true`/`false` cells indicating existing combinations.
504505
*/
@@ -577,7 +578,9 @@ internal interface DataFramePivotCountsCommonDocs
577578

578579
/**
579580
* @include [DataFramePivotCountsCommonDocs]
580-
* @include [SelectingColumns.Dsl]
581+
* Select or express pivot columns using the [PivotDsl].
582+
*
583+
* @include [PivotDslDocs]
581584
*
582585
* ### Example
583586
* ```kotlin
@@ -588,7 +591,7 @@ internal interface DataFramePivotCountsCommonDocs
588591
* ```
589592
*
590593
* @include [PivotDocs.InwardKDocs]
591-
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used as [pivot] keys for the operation.
594+
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used as [pivot] keys for the operation.
592595
* @return A new [DataFrame] representing a counting matrix — with grouping key columns as rows,
593596
* pivot key values as columns, and the number of rows with the corresponding combinations in the cells.
594597
*/
@@ -655,7 +658,7 @@ private interface CommonPivotForGroupByDocs
655658
* @include [CommonPivotForGroupByDocs]
656659
* @include [SelectingColumns.Dsl.WithExample] {@include [SetPivotOperationArg] {@set [SelectingColumns.RECEIVER] <code>`gb`</code>}}
657660
* @include [PivotDocs.InwardKDocsForGrouped]
658-
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are pivoted.
661+
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are pivoted.
659662
* @return A new [PivotGroupBy] that preserves the original [groupBy] key columns
660663
* and pivots the provided columns.
661664
*/
@@ -713,7 +716,9 @@ internal interface GroupByPivotMatchesCommonDocs
713716

714717
/**
715718
* @include [GroupByPivotMatchesCommonDocs]
716-
* @include [SelectingColumns.Dsl]
719+
* Select or express pivot columns using the [PivotDsl].
720+
*
721+
* @include [PivotDslDocs]
717722
*
718723
* ### Example
719724
* ```kotlin
@@ -723,7 +728,7 @@ internal interface GroupByPivotMatchesCommonDocs
723728
* ```
724729
*
725730
* @include [PivotDocs.InwardKDocsForGrouped]
726-
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used as [pivot] keys for the operation.
731+
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used as [pivot] keys for the operation.
727732
* @return A new [DataFrame] representing a Boolean presence matrix — with grouping key columns as rows,
728733
* pivot key values as columns, and `true`/`false` cells indicating existing combinations.
729734
*/
@@ -787,7 +792,9 @@ internal interface GroupByPivotCountsCommonDocs
787792

788793
/**
789794
* @include [GroupByPivotCountsCommonDocs]
790-
* @include [SelectingColumns.Dsl]
795+
* Select or express pivot columns using the [PivotDsl].
796+
*
797+
* @include [PivotDslDocs]
791798
*
792799
* ### Example
793800
* ```kotlin
@@ -797,7 +804,7 @@ internal interface GroupByPivotCountsCommonDocs
797804
* ```
798805
*
799806
* @include [PivotDocs.InwardKDocsForGrouped]
800-
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used as [pivot] keys for the operation.
807+
* @param [columns] The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used as [pivot] keys for the operation.
801808
* @return A new [DataFrame] representing a counting matrix — with grouping key columns as rows,
802809
* pivot key values as columns, and the number of rows with the corresponding combinations in the cells.
803810
*/
@@ -936,8 +943,7 @@ public fun <T> AggregateGroupedDsl<T>.pivot(
936943
* ```
937944
*
938945
* @include [PivotDocs.InwardKDocsForGrouped]
939-
* @param columns The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used
940-
* as keys for pivoting and in which order.
946+
* @param [columns] The [Column Names][String] that defines which columns are used as [pivot] keys for the operation.
941947
* @return A [PivotGroupBy] for further [aggregations][PivotGroupByDocs.Aggregation].
942948
*/
943949
public fun <T> AggregateGroupedDsl<T>.pivot(vararg columns: String, inward: Boolean = true): PivotGroupBy<T> =
@@ -983,7 +989,9 @@ internal interface AggregateGroupedDslPivotMatchesDocs
983989

984990
/**
985991
* @include [AggregateGroupedDslPivotMatchesDocs]
986-
* @include [SelectingColumns.Dsl]
992+
* Select or express pivot columns using the [PivotDsl].
993+
*
994+
* @include [PivotDslDocs]
987995
* ### Example
988996
* ```kotlin
989997
* df.groupBy { name.firstName }.aggregate {
@@ -994,7 +1002,7 @@ internal interface AggregateGroupedDslPivotMatchesDocs
9941002
* ```
9951003
*
9961004
* @include [PivotDocs.InwardKDocsForGrouped]
997-
* @param columns The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used
1005+
* @param columns The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used
9981006
* as keys for pivoting and in which order.
9991007
* @return A new [DataFrame] representing a Boolean presence matrix — with grouping key columns as rows,
10001008
* pivot key values as columns, and `true`/`false` cells indicating existing combinations.
@@ -1067,10 +1075,11 @@ internal interface AggregateGroupedDslPivotCountsDocs
10671075

10681076
/**
10691077
* @include [AggregateGroupedDslPivotCountsDocs]
1070-
* @include [SelectingColumns.Dsl]
1078+
* Select or express pivot columns using the [PivotDsl].
1079+
*
1080+
* @include [PivotDslDocs]
10711081
* ### Example
10721082
* ```kotlin
1073-
* ```kotlin
10741083
* df.groupBy { name.firstName }.aggregate {
10751084
* // Compute number of for all unique values of "city"
10761085
* // across all "name.firstName" key values and adds it to the aggregation result
@@ -1079,7 +1088,7 @@ internal interface AggregateGroupedDslPivotCountsDocs
10791088
* ```
10801089
*
10811090
* @include [PivotDocs.InwardKDocsForGrouped]
1082-
* @param columns The [Pivot Columns Selector][PivotColumnsSelector]that defines which columns are used
1091+
* @param columns The [Pivot Columns Selector][PivotColumnsSelector] that defines which columns are used
10831092
* as keys for pivoting and in which order.
10841093
* @return A new [DataFrame] representing a counting matrix — with grouping key columns as rows,
10851094
* pivot key values as columns, and the number of rows with the corresponding combinations in the cells.

0 commit comments

Comments
 (0)