Documentation and tests for the first and firstOrNull functions
#1547
+641
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allex-Nik
commented
Nov 6, 2025
Allex-Nik
commented
Nov 6, 2025
Allex-Nik
commented
Nov 6, 2025
Allex-Nik
commented
Nov 6, 2025
Allex-Nik
commented
Nov 6, 2025
Allex-Nik
commented
Nov 6, 2025
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
koperagen
reviewed
Nov 6, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
AndreiKingsley
approved these changes
Nov 7, 2025
Collaborator
AndreiKingsley
left a comment
AndreiKingsley
left a comment
There was a problem hiding this comment.
Great job!
Regarding overloads for GroupBy and Pivot - I'm working on a general KDoc system for these operations, so I'll be reworking them anyway in the future, so you can leave them as they are.
AndreiKingsley
requested changes
Nov 7, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Jolanrensen
requested changes
Nov 10, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
zaleslaw
reviewed
Nov 12, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Allex-Nik
commented
Nov 12, 2025
| * @throws [NoSuchElementException] if the [DataColumn] contains no element matching the [predicate] | ||
| * (including the case when the [DataColumn] is empty). | ||
| */ | ||
| public fun <T> DataColumn<T>.first(predicate: (T) -> Boolean): T = values.first(predicate) |
Collaborator
Author
There was a problem hiding this comment.
Is there any reason we do not make this function inline? last in the same case is inline (the same goes for DataColumn<T>.firstOrNull(predicate: (T) -> Boolean))
Jolanrensen
reviewed
Nov 13, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Jolanrensen
reviewed
Nov 13, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Jolanrensen
reviewed
Nov 13, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Allex-Nik
force-pushed
the
first-firstOrNull-documentation-tests
branch
2 times, most recently
from
6e10c71 to
803c080
Compare
Allex-Nik
commented
Nov 27, 2025
Allex-Nik
commented
Nov 27, 2025
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/first.kt
Outdated
Show resolved
Hide resolved
Allex-Nik
force-pushed
the
first-firstOrNull-documentation-tests
branch
from
803c080 to
f3b0fb1
Compare
Allex-Nik
force-pushed
the
first-firstOrNull-documentation-tests
branch
from
f3b0fb1 to
eed2863
Compare
AndreiKingsley
requested changes
Dec 2, 2025
| /** | ||
| * Returns the first [row][DataRow] in this [DataFrame]. | ||
| * | ||
| * @see [DataFrame.firstOrNull] |
Collaborator
There was a problem hiding this comment.
Do you actually need to provide receiver here?
Anyway, please, omit it. Just [firstOrNull] should work, but if not, please use
[firstOrNull][DataFrame.firstOrNull]
Collaborator
There was a problem hiding this comment.
Do it in all other place, please
Collaborator
Author
There was a problem hiding this comment.
We discussed it here: #1547 (comment)
@see [firstOrNull][DataFrame.firstOrNull] still leads to showing the whole thing: DataFrame.firstOrNull.
But I think we can also do it in this style:
See [lastOrNull][DataFrame.lastOrNull],
[first][DataFrame.first],
[take][DataFrame.take],
[takeLast][DataFrame.takeLast],
[takeWhile][DataFrame.takeWhile]
It would look like here:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1279