Skip to content

Commit 4396e8c

Browse files
committed
DOC: Add deprecation infos to deprecated functions (pandas-dev#48599)
* DOC: Add deprecation infos to deprecated functions * Add sections * Fix
1 parent 48dab82 commit 4396e8c

File tree

4 files changed

+69
-8
lines changed

4 files changed

+69
-8
lines changed

pandas/core/groupby/groupby.py

+32-4
Original file line numberDiff line numberDiff line change
@@ -2941,6 +2941,22 @@ def ffill(self, limit=None):
29412941
return self._fill("ffill", limit=limit)
29422942

29432943
def pad(self, limit=None):
2944+
"""
2945+
Forward fill the values.
2946+
2947+
.. deprecated:: 1.4
2948+
Use ffill instead.
2949+
2950+
Parameters
2951+
----------
2952+
limit : int, optional
2953+
Limit of how many values to fill.
2954+
2955+
Returns
2956+
-------
2957+
Series or DataFrame
2958+
Object with missing values filled.
2959+
"""
29442960
warnings.warn(
29452961
"pad is deprecated and will be removed in a future version. "
29462962
"Use ffill instead.",
@@ -2949,8 +2965,6 @@ def pad(self, limit=None):
29492965
)
29502966
return self.ffill(limit=limit)
29512967

2952-
pad.__doc__ = ffill.__doc__
2953-
29542968
@final
29552969
@Substitution(name="groupby")
29562970
def bfill(self, limit=None):
@@ -2977,6 +2991,22 @@ def bfill(self, limit=None):
29772991
return self._fill("bfill", limit=limit)
29782992

29792993
def backfill(self, limit=None):
2994+
"""
2995+
Backward fill the values.
2996+
2997+
.. deprecated:: 1.4
2998+
Use bfill instead.
2999+
3000+
Parameters
3001+
----------
3002+
limit : int, optional
3003+
Limit of how many values to fill.
3004+
3005+
Returns
3006+
-------
3007+
Series or DataFrame
3008+
Object with missing values filled.
3009+
"""
29803010
warnings.warn(
29813011
"backfill is deprecated and will be removed in a future version. "
29823012
"Use bfill instead.",
@@ -2985,8 +3015,6 @@ def backfill(self, limit=None):
29853015
)
29863016
return self.bfill(limit=limit)
29873017

2988-
backfill.__doc__ = bfill.__doc__
2989-
29903018
@final
29913019
@Substitution(name="groupby")
29923020
@Substitution(see_also=_common_see_also)

pandas/core/indexes/base.py

+4
Original file line numberDiff line numberDiff line change
@@ -3810,6 +3810,10 @@ def get_loc(self, key, method=None, tolerance=None):
38103810
* backfill / bfill: use NEXT index value if no exact match
38113811
* nearest: use the NEAREST index value if no exact match. Tied
38123812
distances are broken by preferring the larger index value.
3813+
3814+
.. deprecated:: 1.4
3815+
Use index.get_indexer([item], method=...) instead.
3816+
38133817
tolerance : int or float, optional
38143818
Maximum distance from index value for inexact matches. The value of
38153819
the index at the matching location must satisfy the equation

pandas/core/indexes/interval.py

+2
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,8 @@ def get_loc(
592592
method : {None}, optional
593593
* default: matches where the label is within an interval only.
594594
595+
.. deprecated:: 1.4
596+
595597
Returns
596598
-------
597599
int if unique index, slice if monotonic index, else mask

pandas/core/resample.py

+31-4
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,21 @@ def ffill(self, limit=None):
547547
return self._upsample("ffill", limit=limit)
548548

549549
def pad(self, limit=None):
550+
"""
551+
Forward fill the values.
552+
553+
.. deprecated:: 1.4
554+
Use ffill instead.
555+
556+
Parameters
557+
----------
558+
limit : int, optional
559+
Limit of how many values to fill.
560+
561+
Returns
562+
-------
563+
An upsampled Series.
564+
"""
550565
warnings.warn(
551566
"pad is deprecated and will be removed in a future version. "
552567
"Use ffill instead.",
@@ -555,8 +570,6 @@ def pad(self, limit=None):
555570
)
556571
return self.ffill(limit=limit)
557572

558-
pad.__doc__ = ffill.__doc__
559-
560573
def nearest(self, limit=None):
561574
"""
562575
Resample by using the nearest value.
@@ -720,6 +733,22 @@ def bfill(self, limit=None):
720733
return self._upsample("bfill", limit=limit)
721734

722735
def backfill(self, limit=None):
736+
"""
737+
Backward fill the values.
738+
739+
.. deprecated:: 1.4
740+
Use bfill instead.
741+
742+
Parameters
743+
----------
744+
limit : int, optional
745+
Limit of how many values to fill.
746+
747+
Returns
748+
-------
749+
Series, DataFrame
750+
An upsampled Series or DataFrame with backward filled NaN values.
751+
"""
723752
warnings.warn(
724753
"backfill is deprecated and will be removed in a future version. "
725754
"Use bfill instead.",
@@ -728,8 +757,6 @@ def backfill(self, limit=None):
728757
)
729758
return self.bfill(limit=limit)
730759

731-
backfill.__doc__ = bfill.__doc__
732-
733760
def fillna(self, method, limit=None):
734761
"""
735762
Fill missing values introduced by upsampling.

0 commit comments

Comments
 (0)