Skip to content

Commit bb0be64

Browse files
pivot Kdocs fixes
1 parent 21144a0 commit bb0be64

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,9 +320,9 @@ internal interface GroupByDocs {
320320
interface Pivoting
321321

322322
/**
323-
* Grouping key can also be created inline
323+
* Grouping keys can also be created inline
324324
* (i.g. by creating a new column using [expr] or simply renaming the old one
325-
* using [named]) :
325+
* using [named]):
326326
* ```kotlin
327327
* // Create a new column "newName" based on existing "oldName" values
328328
* // and use it as a grouping key:

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ internal interface PivotDocs {
248248
/**
249249
* Pivoted columns can also be created inline
250250
* (i.g. by creating a new column using [expr] or simply renaming the old one
251-
* using [named]) :
251+
* using [named]):
252252
* ```kotlin
253253
* // Create a new column "newName" based on existing "oldName" values
254254
* // and pivot it:
@@ -445,7 +445,9 @@ public fun <T> DataFrame<T>.pivot(vararg columns: KProperty<*>, inward: Boolean?
445445
// region pivotMatches
446446

447447
/**
448-
* Computes a **presence matrix** (similar to one-hot encoding) for the values in the
448+
* Computes a **presence matrix**
449+
* (similar to [one-hot encoding](https://en.wikipedia.org/wiki/One-hot#Machine_learning_and_statistics))
450+
* for the values in the
449451
* specified [\columns] of this [DataFrame], returning a new [DataFrame] where:
450452
*/
451453
@ExcludeFromSources
@@ -686,7 +688,9 @@ public fun <G> GroupBy<*, G>.pivot(vararg columns: KProperty<*>, inward: Boolean
686688
// region pivotMatches
687689

688690
/**
689-
* Computes a **presence matrix** (similar to one-hot encoding) for the values in the
691+
* Computes a **presence matrix**
692+
* (similar to [one-hot encoding](https://en.wikipedia.org/wiki/One-hot#Machine_learning_and_statistics))
693+
* for the values in the
690694
* specified [\columns] within each group of this [GroupBy], returning a new [DataFrame] where:
691695
* @include [PivotGroupByDocs.ResultingMatrixShortcutDescription]
692696
* @include [PivotMatchesResultCellDescription]

0 commit comments

Comments
 (0)