Skip to content

Commit 0ec74c7

Browse files
committed
Add deprecated filterNotNull for discoverability of dropNulls
1 parent e7fd432 commit 0ec74c7

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

core/api/core.api

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3494,6 +3494,7 @@ public final class org/jetbrains/kotlinx/dataframe/api/NullsKt {
34943494
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
34953495
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
34963496
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
3497+
public static final fun filterNotNull (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
34973498
}
34983499

34993500
public final class org/jetbrains/kotlinx/dataframe/api/ParseKt {

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,15 @@ public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false, columns: Co
383383
}
384384
}
385385

386+
@Refine
387+
@Interpretable("DropNulls0")
388+
@Deprecated(
389+
"DataFrame conventional name for filterNot* functions is drop*",
390+
ReplaceWith("dropNulls(columns = columns)"),
391+
DeprecationLevel.ERROR,
392+
)
393+
public fun <T> DataFrame<T>.filterNotNull(columns: ColumnsSelector<T, *>): DataFrame<T> = dropNulls(columns = columns)
394+
386395
/**
387396
* @include [CommonDropNullsFunctionDoc]
388397
* This overload operates on all columns in the [DataFrame].

docs/StardustDocs/topics/drop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ df.drop { it["weight"] == null || it["city"] == null }
2727

2828
## dropNulls
2929

30-
Remove rows with `null` values
30+
Remove rows with `null` values. This is a DataFrame equivalent of `filterNotNull`.
3131

3232
See [column selectors](ColumnSelectors.md) for how to select the columns for this operation.
3333

0 commit comments

Comments
 (0)