Skip to content

Commit bb17665

Browse files
thiphan94pmhatre1
authored andcommitted
Fix docstring (pandas-dev#57014)
* fix PR02 in resampling function * fix PR02 in interpolate function * fix PR02 in string function * fix PR02 in string function * fix PR02 in groupby function * fix lint error
1 parent f0b65da commit bb17665

File tree

5 files changed

+8
-10
lines changed

5 files changed

+8
-10
lines changed

ci/code_checks.sh

-4
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
113113
pandas.Series.dt.ceil\
114114
pandas.Series.dt.month_name\
115115
pandas.Series.dt.day_name\
116-
pandas.Series.str.count\
117116
pandas.Series.str.wrap\
118117
pandas.Series.cat.rename_categories\
119118
pandas.Series.cat.reorder_categories\
@@ -126,7 +125,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
126125
pandas.Series.plot.line\
127126
pandas.Series.plot.pie\
128127
pandas.DataFrame.clip\
129-
pandas.DataFrame.interpolate\
130128
pandas.DataFrame.plot\
131129
pandas.DataFrame.plot.bar\
132130
pandas.DataFrame.plot.barh\
@@ -185,7 +183,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
185183
pandas.Interval\
186184
pandas.Grouper\
187185
pandas.core.groupby.SeriesGroupBy.apply\
188-
pandas.core.groupby.DataFrameGroupBy.apply\
189186
pandas.core.groupby.SeriesGroupBy.transform\
190187
pandas.core.groupby.DataFrameGroupBy.transform\
191188
pandas.core.groupby.DataFrameGroupBy.nth\
@@ -201,7 +198,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
201198
pandas.HDFStore.append\
202199
pandas.core.window.rolling.Rolling.quantile\
203200
pandas.core.window.expanding.Expanding.quantile\
204-
pandas.core.resample.Resampler.interpolate\
205201
pandas.api.extensions.ExtensionArray.argsort # There should be no backslash in the final line, please keep this comment in the last ignored function
206202
RET=$(($RET + $?)) ; echo $MSG "DONE"
207203

pandas/core/generic.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8296,7 +8296,7 @@ def interpolate(
82968296
82978297
.. deprecated:: 2.1.0
82988298
8299-
``**kwargs`` : optional
8299+
**kwargs : optional
83008300
Keyword arguments to pass on to the interpolating function.
83018301
83028302
Returns

pandas/core/groupby/groupby.py

+6-2
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,10 @@ class providing the base-class of operations.
192192
A callable that takes a {input} as its first argument, and
193193
returns a dataframe, a series or a scalar. In addition the
194194
callable may take positional and keyword arguments.
195+
196+
*args : tuple
197+
Optional positional arguments to pass to ``func``.
198+
195199
include_groups : bool, default True
196200
When True, will attempt to apply ``func`` to the groupings in
197201
the case that they are columns of the DataFrame. If this raises a
@@ -205,8 +209,8 @@ class providing the base-class of operations.
205209
Setting include_groups to True is deprecated. Only the value
206210
False will be allowed in a future version of pandas.
207211
208-
args, kwargs : tuple and dict
209-
Optional positional and keyword arguments to pass to ``func``.
212+
**kwargs : dict
213+
Optional keyword arguments to pass to ``func``.
210214
211215
Returns
212216
-------

pandas/core/resample.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1028,7 +1028,7 @@ def interpolate(
10281028
10291029
.. deprecated:: 2.1.0
10301030
1031-
``**kwargs`` : optional
1031+
**kwargs : optional
10321032
Keyword arguments to pass on to the interpolating function.
10331033
10341034
Returns

pandas/core/strings/accessor.py

-2
Original file line numberDiff line numberDiff line change
@@ -2351,8 +2351,6 @@ def count(self, pat, flags: int = 0):
23512351
flags : int, default 0, meaning no flags
23522352
Flags for the `re` module. For a complete list, `see here
23532353
<https://docs.python.org/3/howto/regex.html#compilation-flags>`_.
2354-
**kwargs
2355-
For compatibility with other string methods. Not used.
23562354
23572355
Returns
23582356
-------

0 commit comments

Comments
 (0)