Add documentation and tests for the last and lastOrNull functions
#1561
Conversation
Allex-Nik
requested review from
AndreiKingsley,
Jolanrensen,
koperagen and
zaleslaw
|
The checks fail for now because in the documentation I refer to |
| */ | ||
| class LastTests : ColumnsSelectionDslTests() { | ||
|
|
||
| // region ColumnsSelectionDsl |
There was a problem hiding this comment.
I was thinking that a test file could benefit from these regions as well. Is it a good idea to add it here?
| * and returns a [ReducedGroupBy] containing these rows | ||
| * (one row per group, each row is the last row in its group). | ||
| * | ||
| * If the group in [GroupBy] is empty, |
There was a problem hiding this comment.
I mentioned that it will return null for empty groups, but there is still the issue I mentioned for this case in #1547:
https://github.com/Kotlin/dataframe/pull/1547/files#r2505104735
There was a problem hiding this comment.
could you create an issue for that? I probably should have done that myself when finding the reproducer... But it makes it easier to track and refer to :)
There was a problem hiding this comment.
Yes, sure! I probably should have done it right away, I just wasn't 100% sure :)
I expect it to be merged soon. If it takes too long, you can also copy the code from #1554 and let git handle the merge. Whatever you like best :) |
| /** | ||
| * Returns the last value in this [DataColumn]. | ||
| * | ||
| * See also [lastOrNull], [first], [take], [takeLast]. |
There was a problem hiding this comment.
There's also the @see tag if you just want to refer to other functions.
The only downside of @see is that you cannot add "extra" text to it. That's why we often write things like "See [something] for some reason."
However, if you don't need a description, you can simply write
@see [lastOrNull]
@see [first]
etc.
Fixes #1497