diff --git a/spec/API_specification/dataframe_api/column_object.py b/spec/API_specification/dataframe_api/column_object.py index c8eb666f..960462ff 100644 --- a/spec/API_specification/dataframe_api/column_object.py +++ b/spec/API_specification/dataframe_api/column_object.py @@ -104,7 +104,7 @@ def slice_rows( ... - def get_rows_by_mask(self: Column[DType], mask: Column[Bool]) -> Column[DType]: + def filter(self: Column[DType], mask: Column[Bool]) -> Column[DType]: """ Select a subset of rows corresponding to a mask. diff --git a/spec/API_specification/dataframe_api/dataframe_object.py b/spec/API_specification/dataframe_api/dataframe_object.py index 7383e1d2..4eb43279 100644 --- a/spec/API_specification/dataframe_api/dataframe_object.py +++ b/spec/API_specification/dataframe_api/dataframe_object.py @@ -161,7 +161,7 @@ def slice_rows( """ ... - def get_rows_by_mask(self, mask: Column[Bool]) -> DataFrame: + def filter(self, mask: Column[Bool]) -> DataFrame: """ Select a subset of rows corresponding to a mask. diff --git a/spec/purpose_and_scope.md b/spec/purpose_and_scope.md index 199d1a74..65e76e17 100644 --- a/spec/purpose_and_scope.md +++ b/spec/purpose_and_scope.md @@ -287,7 +287,7 @@ def my_dataframe_agnostic_function(df): df = df.__dataframe_consortium_standard__(api_version='2023.08-beta') mask = df.get_column_by_name('species') != 'setosa' - df = df.get_rows_by_mask(mask) + df = df.filter(mask) for column_name in df.get_column_names(): if column_name == 'species':