Skip to content

DOC: Remove references to bfill, ffill, pad, and backfill in limit_direction #57720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 5, 2024
Merged

DOC: Remove references to bfill, ffill, pad, and backfill in limit_direction #57720

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c1d817
Remove references to `bfill`, `ffill`, `pad`, `backfill` from `limit_…
sjalkote Mar 4, 2024
8678386
Add `bfill` and `ffill` to the "See Also" section
sjalkote Mar 4, 2024
8a29b68
Merge branch 'main' into main
sjalkote Mar 4, 2024
80d362b
Merge branch 'pandas-dev:main' into main
sjalkote Mar 5, 2024
7dfd363
Add `bfill` and `ffill` to the "See Also" section
sjalkote Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions pandas/core/resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,20 +819,6 @@ def interpolate(
limit_direction : {{'forward', 'backward', 'both'}}, Optional
Consecutive NaNs will be filled in this direction.

If limit is specified:
* If 'method' is 'pad' or 'ffill', 'limit_direction' must be 'forward'.
* If 'method' is 'backfill' or 'bfill', 'limit_direction' must be
'backwards'.

If 'limit' is not specified:
* If 'method' is 'backfill' or 'bfill', the default is 'backward'
* else the default is 'forward'

raises ValueError if `limit_direction` is 'forward' or 'both' and
method is 'backfill' or 'bfill'.
raises ValueError if `limit_direction` is 'backward' or 'both' and
method is 'pad' or 'ffill'.

limit_area : {{`None`, 'inside', 'outside'}}, default None
If limit is specified, consecutive NaNs will be filled with this
restriction.
Expand Down Expand Up @@ -860,6 +846,8 @@ def interpolate(
core.resample.Resampler.asfreq: Return the values at the new freq,
essentially a reindex.
DataFrame.interpolate: Fill NaN values using an interpolation method.
DataFrame.bfill : Backward fill NaN values in the resampled data.
DataFrame.ffill : Forward fill NaN values.

Notes
-----
Expand Down