Skip to content

Commit c2f96cd

Browse files
committed
Update kdocs of sortByColumns
1 parent d14eaac commit c2f96cd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/KotlinNotebookPluginUtils.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ public object KotlinNotebookPluginUtils {
7373
/**
7474
* Sorts a dataframe-like object by multiple columns.
7575
* If a column type is not comparable, sorting by string representation is applied instead.
76+
* Sorts DataFrames by their size because looking at the smallest / biggest groups after groupBy is very popular.
77+
*
78+
* Returns "lazily materialized" dataframe, which means get, getRows, take operation must be applied to turn it to a valid sorted dataframe.
79+
* "lazily materialized" - after sorting 1 million of rows and given the page size = 100, a dataframe with only 100 rows is created.
7680
*
7781
* @param dataFrameLike The dataframe-like object to sort.
7882
* @param columnPaths The list of columns to sort by. Each element in the list represents a column path

0 commit comments

Comments
 (0)