Skip to content

Commit 991760d

Browse files
committed
Fixes to the documentation for the first and firstOrNull functions after review: removed redundant parentheses around include.
1 parent 5833dcf commit 991760d

File tree

1 file changed

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

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ public fun <T> DataFrame<T>.firstOrNull(): DataRow<T>? = if (nrow > 0) first() e
139139
/**
140140
* Returns the first [row][DataRow] in this [DataFrame] that satisfies the given [predicate].
141141
*
142-
* {@include [RowFilterDescription]}
142+
* @include [RowFilterDescription]
143143
*
144144
* @include [SelectingColumns.ColumnGroupsAndNestedColumnsMention]
145145
*
@@ -173,7 +173,7 @@ public inline fun <T> DataFrame<T>.first(predicate: RowFilter<T>): DataRow<T> =
173173
* Returns `null` if the [DataFrame] contains no rows matching the [predicate]
174174
* (including the case when the [DataFrame] is empty).
175175
*
176-
* {@include [RowFilterDescription]}
176+
* @include [RowFilterDescription]
177177
*
178178
* @include [SelectingColumns.ColumnGroupsAndNestedColumnsMention]
179179
*
@@ -241,7 +241,7 @@ public fun <T, G> GroupBy<T, G>.first(): ReducedGroupBy<T, G> = reduce { firstOr
241241
* the corresponding row in [ReducedGroupBy] will contain `null` values for all columns in the group,
242242
* except the grouping key.
243243
*
244-
* {@include [RowFilterDescription]}
244+
* @include [RowFilterDescription]
245245
*
246246
* @include [SelectingColumns.ColumnGroupsAndNestedColumnsMention]
247247
*
@@ -293,7 +293,7 @@ public fun <T> Pivot<T>.first(): ReducedPivot<T> = reduce { firstOrNull() }
293293
*
294294
* For more information about [Pivot] with examples: {@include [DocumentationUrls.Pivot]}
295295
*
296-
* {@include [RowFilterDescription]}
296+
* @include [RowFilterDescription]
297297
*
298298
* @include [SelectingColumns.ColumnGroupsAndNestedColumnsMention]
299299
*
@@ -355,13 +355,13 @@ public fun <T> PivotGroupBy<T>.first(): ReducedPivotGroupBy<T> = reduce { firstO
355355
* in the resulting [ReducedPivotGroupBy] it will be represented by a [row][DataRow] with `null` values
356356
* (except the grouping key).
357357
*
358-
* {@include [DocumentationUrls.PivotGroupBy]}
358+
* @include [DocumentationUrls.PivotGroupBy]
359359
*
360-
* {@include [DocumentationUrls.Pivot]}
360+
* @include [DocumentationUrls.Pivot]
361361
*
362-
* {@include [DocumentationUrls.GroupBy]}
362+
* @include [DocumentationUrls.GroupBy]
363363
*
364-
* {@include [RowFilterDescription]}
364+
* @include [RowFilterDescription]
365365
*
366366
* @include [SelectingColumns.ColumnGroupsAndNestedColumnsMention]
367367
*

0 commit comments

Comments
 (0)