Skip to content

Commit 1248ad1

Browse files
committed
added missing doc() decorators
1 parent 9032a7b commit 1248ad1

File tree

6 files changed

+25
-21
lines changed

6 files changed

+25
-21
lines changed

pandas/core/groupby/generic.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,10 @@ def _selection_name(self):
224224
def apply(self, func, *args, **kwargs):
225225
return super().apply(func, *args, **kwargs)
226226

227-
@Substitution(
228-
examples=_agg_examples_doc, klass="Series",
227+
@doc(
228+
_agg_template,
229+
examples=_agg_examples_doc,
230+
klass="Series",
229231
)
230232
@Appender(_agg_template)
231233
def aggregate(
@@ -914,10 +916,11 @@ class DataFrameGroupBy(GroupBy[DataFrame]):
914916
See :ref:`groupby.aggregate.named` for more."""
915917
)
916918

917-
@Substitution(
918-
examples=_agg_examples_doc, klass="DataFrame",
919+
@doc(
920+
_agg_template,
921+
examples=_agg_examples_doc,
922+
klass="DataFrame",
919923
)
920-
@Appender(_agg_template)
921924
def aggregate(
922925
self, func=None, *args, engine="cython", engine_kwargs=None, **kwargs
923926
):

pandas/core/resample.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,14 @@ def pipe(self, func, *args, **kwargs):
274274
"""
275275
)
276276

277-
@Substitution(
277+
@doc(
278+
_shared_docs["aggregate"],
278279
see_also=_agg_see_also_doc,
279280
examples=_agg_examples_doc,
280281
versionadded="",
281282
klass="DataFrame",
282283
axis="",
283284
)
284-
@Appender(_shared_docs["aggregate"])
285285
def aggregate(self, func, *args, **kwargs):
286286

287287
self._set_binner()

pandas/core/series.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3965,13 +3965,14 @@ def _gotitem(self, key, ndim, subset=None) -> "Series":
39653965
"""
39663966
)
39673967

3968-
@Substitution(
3968+
@doc(
3969+
generic._shared_docs["aggregate"],
3970+
klass=_shared_doc_kwargs["klass"],
3971+
axis=_shared_doc_kwargs["axis"],
39693972
see_also=_agg_see_also_doc,
39703973
examples=_agg_examples_doc,
39713974
versionadded="\n.. versionadded:: 0.20.0\n",
3972-
**_shared_doc_kwargs,
39733975
)
3974-
@Appender(generic._shared_docs["aggregate"])
39753976
def aggregate(self, func, axis=0, *args, **kwargs):
39763977
# Validate the axis parameter
39773978
self._get_axis_number(axis)

pandas/core/window/ewm.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import pandas._libs.window.aggregations as window_aggregations
66
from pandas.compat.numpy import function as nv
7-
from pandas.util._decorators import Appender, Substitution
7+
from pandas.util._decorators import Appender, Substitution, doc
88

99
from pandas.core.dtypes.generic import ABCDataFrame
1010

@@ -206,14 +206,14 @@ def _constructor(self):
206206
"""
207207
)
208208

209-
@Substitution(
209+
@doc(
210+
_shared_docs["aggregate"],
210211
see_also=_agg_see_also_doc,
211212
examples=_agg_examples_doc,
212213
versionadded="",
213214
klass="Series/Dataframe",
214215
axis="",
215216
)
216-
@Appender(_shared_docs["aggregate"])
217217
def aggregate(self, func, *args, **kwargs):
218218
return super().aggregate(func, *args, **kwargs)
219219

pandas/core/window/expanding.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from typing import Dict, Optional
33

44
from pandas.compat.numpy import function as nv
5-
from pandas.util._decorators import Appender, Substitution
5+
from pandas.util._decorators import Appender, Substitution, doc
66

77
from pandas.core.window.common import WindowGroupByMixin, _doc_template, _shared_docs
88
from pandas.core.window.rolling import _Rolling_and_Expanding
@@ -113,14 +113,14 @@ def _get_window(self, other=None, **kwargs):
113113
"""
114114
)
115115

116-
@Substitution(
116+
@doc(
117+
_shared_docs["aggregate"],
117118
see_also=_agg_see_also_doc,
118119
examples=_agg_examples_doc,
119120
versionadded="",
120121
klass="Series/Dataframe",
121122
axis="",
122123
)
123-
@Appender(_shared_docs["aggregate"])
124124
def aggregate(self, func, *args, **kwargs):
125125
return super().aggregate(func, *args, **kwargs)
126126

pandas/core/window/rolling.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from pandas._typing import Axis, FrameOrSeries, Scalar
1616
from pandas.compat._optional import import_optional_dependency
1717
from pandas.compat.numpy import function as nv
18-
from pandas.util._decorators import Appender, Substitution, cache_readonly
18+
from pandas.util._decorators import Appender, Substitution, cache_readonly, doc
1919

2020
from pandas.core.dtypes.common import (
2121
ensure_float64,
@@ -1151,14 +1151,14 @@ def _get_window(
11511151
"""
11521152
)
11531153

1154-
@Substitution(
1154+
@doc(
1155+
_shared_docs["aggregate"],
11551156
see_also=_agg_see_also_doc,
11561157
examples=_agg_examples_doc,
11571158
versionadded="",
11581159
klass="Series/DataFrame",
11591160
axis="",
11601161
)
1161-
@Appender(_shared_docs["aggregate"])
11621162
def aggregate(self, func, *args, **kwargs):
11631163
result, how = self._aggregate(func, *args, **kwargs)
11641164
if result is None:
@@ -2020,14 +2020,14 @@ def _validate_freq(self):
20202020
"""
20212021
)
20222022

2023-
@Substitution(
2023+
@doc(
2024+
_shared_docs["aggregate"],
20242025
see_also=_agg_see_also_doc,
20252026
examples=_agg_examples_doc,
20262027
versionadded="",
20272028
klass="Series/Dataframe",
20282029
axis="",
20292030
)
2030-
@Appender(_shared_docs["aggregate"])
20312031
def aggregate(self, func, *args, **kwargs):
20322032
return super().aggregate(func, *args, **kwargs)
20332033

0 commit comments

Comments
 (0)