Skip to content

Commit eed2863

Browse files
committed
Fixes to the KDoc of the tests for the first and firstOrNull functions after review
1 parent 0bc74df commit eed2863

File tree

1 file changed

+13
-9
lines changed
  • core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+13
-9
lines changed

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

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ package org.jetbrains.kotlinx.dataframe.api
22

33
import io.kotest.assertions.throwables.shouldThrow
44
import io.kotest.matchers.shouldBe
5+
import org.jetbrains.kotlinx.dataframe.DataColumn
6+
import org.jetbrains.kotlinx.dataframe.DataFrame
7+
import org.jetbrains.kotlinx.dataframe.DataRow
58
import org.jetbrains.kotlinx.dataframe.nrow
69
import org.jetbrains.kotlinx.dataframe.samples.api.age
710
import org.jetbrains.kotlinx.dataframe.samples.api.firstName
@@ -12,26 +15,27 @@ import org.jetbrains.kotlinx.dataframe.samples.api.weight
1215
import org.junit.Test
1316

1417
/**
15-
* Tests the behavior of the `first` (`firstCol`) and `firstOrNull` functions, including:
18+
* Tests the behavior of the [first] ([FirstColumnsSelectionDsl.firstCol]) and [firstOrNull] functions, including:
1619
*
17-
* - **ColumnsSelectionDsl**: selecting the first column or first column matching a condition, with invocations
20+
* - [ColumnsSelectionDsl]: selecting the first column or first column matching a condition, with invocations
1821
* on illegal types, and in case when no column matches the condition.
1922
*
20-
* - **DataColumn**: getting the first value or the first value matching a predicate,
23+
* - [DataColumn]: getting the first value or the first value matching a predicate,
2124
* verifying behavior on empty columns, columns with `null` values, and columns without values matching the predicate.
2225
*
23-
* - **DataFrame**: getting the first row or first matching row,
26+
* - [DataFrame]: getting the first [row][DataRow] or first matching [row][DataRow],
2427
* verifying behavior on empty DataFrames, DataFrames with `null` values, and
2528
* DataFrames without rows matching the predicate.
2629
*
27-
* - **GroupBy**: reducing each group to its first row or the first row matching a predicate,
30+
* - [GroupBy]: reducing each group to its first [row][DataRow] or the first [row][DataRow] matching a predicate,
2831
* with handling groups that contain no matching rows.
2932
*
30-
* - **Pivot**: reducing each group in the pivot to its first row or the first row matching a predicate,
31-
* with handling groups that contain no matching rows.
33+
* - [Pivot]: reducing each group in the [Pivot] to its first [row][DataRow]
34+
* or the first [row][DataRow] matching a predicate, with handling groups that contain no matching rows.
3235
*
33-
* - **PivotGroupBy**: reducing each combined [pivot] + [groupBy] group to its first row
34-
* or the first row matching a predicate, with handling [pivot] + [groupBy] combinations that contain no matching rows.
36+
* - [PivotGroupBy]: reducing each combined [pivot] + [groupBy] group to its first [row][DataRow]
37+
* or the first [row][DataRow] matching a predicate,
38+
* with handling [pivot] + [groupBy] combinations that contain no matching rows.
3539
*/
3640
class FirstTests : ColumnsSelectionDslTests() {
3741

0 commit comments

Comments
 (0)