Skip to content

Commit 7a69821

Browse files
committed
update docs
1 parent 92f7e46 commit 7a69821

File tree

6 files changed

+9
-11
lines changed

6 files changed

+9
-11
lines changed

doc/redirects.csv

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,6 @@ generated/pandas.DataFrame.ewm,../reference/api/pandas.DataFrame.ewm
358358
generated/pandas.DataFrame.expanding,../reference/api/pandas.DataFrame.expanding
359359
generated/pandas.DataFrame.ffill,../reference/api/pandas.DataFrame.ffill
360360
generated/pandas.DataFrame.fillna,../reference/api/pandas.DataFrame.fillna
361-
generated/pandas.DataFrame.filter,../reference/api/pandas.DataFrame.filter
362361
generated/pandas.DataFrame.first,../reference/api/pandas.DataFrame.first
363362
generated/pandas.DataFrame.first_valid_index,../reference/api/pandas.DataFrame.first_valid_index
364363
generated/pandas.DataFrame.floordiv,../reference/api/pandas.DataFrame.floordiv
@@ -1023,7 +1022,6 @@ generated/pandas.Series.expanding,../reference/api/pandas.Series.expanding
10231022
generated/pandas.Series.factorize,../reference/api/pandas.Series.factorize
10241023
generated/pandas.Series.ffill,../reference/api/pandas.Series.ffill
10251024
generated/pandas.Series.fillna,../reference/api/pandas.Series.fillna
1026-
generated/pandas.Series.filter,../reference/api/pandas.Series.filter
10271025
generated/pandas.Series.first,../reference/api/pandas.Series.first
10281026
generated/pandas.Series.first_valid_index,../reference/api/pandas.Series.first_valid_index
10291027
generated/pandas.Series.floordiv,../reference/api/pandas.Series.floordiv

doc/source/reference/frame.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,6 @@ Reindexing / selection / label manipulation
184184
DataFrame.drop_duplicates
185185
DataFrame.duplicated
186186
DataFrame.equals
187-
DataFrame.filter
188187
DataFrame.idxmax
189188
DataFrame.idxmin
190189
DataFrame.reindex
@@ -193,6 +192,7 @@ Reindexing / selection / label manipulation
193192
DataFrame.rename_axis
194193
DataFrame.reset_index
195194
DataFrame.sample
195+
DataFrame.select
196196
DataFrame.set_axis
197197
DataFrame.set_index
198198
DataFrame.take

doc/source/reference/series.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Reindexing / selection / label manipulation
201201
Series.mask
202202
Series.add_prefix
203203
Series.add_suffix
204-
Series.filter
204+
Series.select
205205

206206
Missing data handling
207207
---------------------

doc/source/user_guide/gotchas.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Mutating with User Defined Function (UDF) methods
165165

166166
This section applies to pandas methods that take a UDF. In particular, the methods
167167
:meth:`DataFrame.apply`, :meth:`DataFrame.aggregate`, :meth:`DataFrame.transform`, and
168-
:meth:`DataFrame.filter`.
168+
:meth:`DataFrame.select`.
169169

170170
It is a general rule in programming that one should not mutate a container
171171
while it is being iterated over. Mutation will invalidate the iterator,

doc/source/user_guide/user_defined_functions.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -261,13 +261,13 @@ calling multiple functions.
261261

262262
When to use: Use :meth:`pipe` when you need to create a pipeline of operations and want to keep the code readable and maintainable.
263263

264-
.. _udf.filter:
264+
.. _udf.select:
265265

266-
:meth:`Series.filter` and :meth:`DataFrame.filter`
266+
:meth:`Series.select` and :meth:`DataFrame.select`
267267
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268268

269-
The ``filter`` method is used to select a subset of rows that match certain criteria.
270-
:meth:`Series.filter` and :meth:`DataFrame.filter` do not support user defined functions,
269+
The ``select`` method is used to select a subset of rows that match certain criteria.
270+
:meth:`Series.select` and :meth:`DataFrame.select` do not support user defined functions,
271271
but :meth:`SeriesGroupBy.filter` and :meth:`DataFrameGroupBy.filter` do. You can read more
272272
about ``filter`` in groupby operations in :ref:`groupby.filter`.
273273

pandas/core/groupby/generic.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,7 @@ def filter(self, func, dropna: bool = True, *args, **kwargs):
756756
757757
See Also
758758
--------
759-
Series.filter: Filter elements of ungrouped Series.
759+
Series.select : Select elements of ungrouped Series.
760760
DataFrameGroupBy.filter : Filter elements from groups base on criterion.
761761
762762
Notes
@@ -2380,7 +2380,7 @@ def filter(self, func, dropna: bool = True, *args, **kwargs) -> DataFrame:
23802380
23812381
See Also
23822382
--------
2383-
DataFrame.filter: Filter elements of ungrouped DataFrame.
2383+
DataFrame.select: Select elements of ungrouped DataFrame.
23842384
SeriesGroupBy.filter : Filter elements from groups base on criterion.
23852385
23862386
Notes

0 commit comments

Comments
 (0)