Skip to content

Commit dad572d

Browse files
gather docs fixes
1 parent c3b1f77 commit dad572d

File tree

1 file changed

+12
-9
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+12
-9
lines changed

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,12 @@ import kotlin.reflect.typeOf
6161
internal interface GatherDocs {
6262

6363
/**
64-
* ## {@get [GATHER_OPERATION]} Operation Grammar
64+
* ## [gather][gather] Operation Grammar
6565
* {@include [LineBreak]}
6666
* {@include [DslGrammarLink]}
6767
* {@include [LineBreak]}
6868
*
69-
* **[`gather`][gather]****` { `**`columnsSelector: `[`ColumnsSelector`][ColumnsSelector]**` }`**
69+
* [**`gather`**][gather]**` { `**`columnsSelector: `[`ColumnsSelector`][ColumnsSelector]**` }`**
7070
*
7171
* {@include [Indent]}
7272
* `\[ `__`.`__[**`explodeLists`**][Gather.explodeLists]**`() `**`]`
@@ -94,7 +94,6 @@ internal interface GatherDocs {
9494
*
9595
* {@include [Indent]}
9696
* `| `__`.`__[**`valuesInto`**][Gather.valuesInto]**`(`**`valueColumn: `[`String`][String]**`)`**
97-
* {@set [GATHER_OPERATION] [**`gather`**][gather]}{@comment The default name of the `gather` operation function name.}
9897
*/
9998
interface Grammar
10099

@@ -173,7 +172,7 @@ public fun <T, C> DataFrame<T>.gather(vararg columns: KProperty<C>): Gather<T, C
173172
* Filter values in columns previously selected by [gather] using a [filter][RowValueFilter].
174173
*
175174
* [RowValueFilter] provides each value as a lambda argument, allowing you
176-
* to filter rows using a Boolean condition.
175+
* to filter rows using a [Boolean] condition.
177176
*
178177
* It's an intermediate step; returns a new [Gather] with filtered value columns.
179178
*
@@ -238,7 +237,9 @@ public fun <T, C, K, R> Gather<T, C, K, R>.where(filter: RowValueFilter<T, C>):
238237
public fun <T, C, K, R> Gather<T, C?, K, R>.notNull(): Gather<T, C, K, R> = where { it != null } as Gather<T, C, K, R>
239238

240239
/**
241-
* Explodes [List] values in the columns previously selected by [gather].
240+
* Explodes [List] values — i.e., splits each list into individual elements,
241+
* creating a separate row for each element, and duplicating all other columns —
242+
* in the columns previously selected by [gather].
242243
*
243244
* If not all values are lists (for example, if one column contains `Double` values and
244245
* another contains `List<Double>`), only the list values will be exploded — non-list values remain unchanged.
@@ -319,7 +320,7 @@ public fun <T, C, K, R> Gather<T, List<C>, K, R>.explodeLists(): Gather<T, C, K,
319320
) as Gather<T, C, K, R>
320321

321322
/**
322-
* Applies a [transform] to the gathering keys —
323+
* Applies [transform] to the gathering keys —
323324
* that is, the names of the columns previously selected by [gather].
324325
*
325326
* This is an intermediate step; returns a new [Gather] with transformed keys.
@@ -354,7 +355,7 @@ public inline fun <T, C, reified K, R> Gather<T, C, *, R>.mapKeys(
354355
)
355356

356357
/**
357-
* Applies a [transform] to the values from the columns previously selected by [gather].
358+
* Applies [transform] to the values from the columns previously selected by [gather].
358359
*
359360
* This is an intermediate step; returns a new [Gather] with transformed values.
360361
*
@@ -473,7 +474,8 @@ public class Gather<T, C, K, R>(
473474
* while all other columns remain unchanged —
474475
* except that their values are duplicated for each generated key-value pair.
475476
*
476-
* Resulting key and value values can be adjusted using [mapKeys] and [mapValues], respectively.
477+
* Key and value values can be adjusted beforehand
478+
* using [mapKeys] and [mapValues], respectively.
477479
*
478480
* For more information, see: {@include [DocumentationUrls.Gather]}
479481
*
@@ -536,9 +538,9 @@ public fun <T, C, K, R> Gather<T, C, K, R>.into(keyColumn: KProperty<K>, valueCo
536538
* df.gather { cols { it.name().contains("series") } }
537539
* .keysInto("seriesType")
538540
* ```
539-
*
540541
* @param keyColumn The name of the column to store keys (original column names by default).
541542
* @return A new [DataFrame] with reshaped columns.
543+
* @see [valuesInto]
542544
*/
543545
@Refine
544546
@Interpretable("GatherKeysInto")
@@ -583,6 +585,7 @@ public fun <T, C, K, R> Gather<T, C, K, R>.keysInto(keyColumn: KProperty<K>): Da
583585
*
584586
* @param valueColumn The name of the column to store gathered values.
585587
* @return A new [DataFrame] with reshaped columns.
588+
* @see [keysInto]
586589
*/
587590
@Refine
588591
@Interpretable("GatherValuesInto")

0 commit comments

Comments
 (0)