Skip to content

Commit d4477f6

Browse files
committed
added missing doc() decorators
1 parent c222204 commit d4477f6

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
@@ -223,8 +223,10 @@ def _selection_name(self):
223223
def apply(self, func, *args, **kwargs):
224224
return super().apply(func, *args, **kwargs)
225225

226-
@Substitution(
227-
examples=_agg_examples_doc, klass="Series",
226+
@doc(
227+
_agg_template,
228+
examples=_agg_examples_doc,
229+
klass="Series",
228230
)
229231
@Appender(_agg_template)
230232
def aggregate(
@@ -907,10 +909,11 @@ class DataFrameGroupBy(GroupBy[DataFrame]):
907909
See :ref:`groupby.aggregate.named` for more."""
908910
)
909911

910-
@Substitution(
911-
examples=_agg_examples_doc, klass="DataFrame",
912+
@doc(
913+
_agg_template,
914+
examples=_agg_examples_doc,
915+
klass="DataFrame",
912916
)
913-
@Appender(_agg_template)
914917
def aggregate(
915918
self, func=None, *args, engine="cython", engine_kwargs=None, **kwargs
916919
):

pandas/core/resample.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,14 +267,14 @@ def pipe(self, func, *args, **kwargs):
267267
"""
268268
)
269269

270-
@Substitution(
270+
@doc(
271+
_shared_docs["aggregate"],
271272
see_also=_agg_see_also_doc,
272273
examples=_agg_examples_doc,
273274
versionadded="",
274275
klass="DataFrame",
275276
axis="",
276277
)
277-
@Appender(_shared_docs["aggregate"])
278278
def aggregate(self, func, *args, **kwargs):
279279

280280
self._set_binner()

pandas/core/series.py

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

3828-
@Substitution(
3828+
@doc(
3829+
generic._shared_docs["aggregate"],
3830+
klass=_shared_doc_kwargs["klass"],
3831+
axis=_shared_doc_kwargs["axis"],
38293832
see_also=_agg_see_also_doc,
38303833
examples=_agg_examples_doc,
38313834
versionadded="\n.. versionadded:: 0.20.0\n",
3832-
**_shared_doc_kwargs,
38333835
)
3834-
@Appender(generic._shared_docs["aggregate"])
38353836
def aggregate(self, func, axis=0, *args, **kwargs):
38363837
# Validate the axis parameter
38373838
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

@@ -182,14 +182,14 @@ def _constructor(self):
182182
"""
183183
)
184184

185-
@Substitution(
185+
@doc(
186+
_shared_docs["aggregate"],
186187
see_also=_agg_see_also_doc,
187188
examples=_agg_examples_doc,
188189
versionadded="",
189190
klass="Series/Dataframe",
190191
axis="",
191192
)
192-
@Appender(_shared_docs["aggregate"])
193193
def aggregate(self, func, *args, **kwargs):
194194
return super().aggregate(func, *args, **kwargs)
195195

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
@@ -14,7 +14,7 @@
1414
from pandas._typing import Axis, FrameOrSeries, Scalar
1515
from pandas.compat._optional import import_optional_dependency
1616
from pandas.compat.numpy import function as nv
17-
from pandas.util._decorators import Appender, Substitution, cache_readonly
17+
from pandas.util._decorators import Appender, Substitution, cache_readonly, doc
1818

1919
from pandas.core.dtypes.common import (
2020
ensure_float64,
@@ -1065,14 +1065,14 @@ def _get_window(
10651065
"""
10661066
)
10671067

1068-
@Substitution(
1068+
@doc(
1069+
_shared_docs["aggregate"],
10691070
see_also=_agg_see_also_doc,
10701071
examples=_agg_examples_doc,
10711072
versionadded="",
10721073
klass="Series/DataFrame",
10731074
axis="",
10741075
)
1075-
@Appender(_shared_docs["aggregate"])
10761076
def aggregate(self, func, *args, **kwargs):
10771077
result, how = self._aggregate(func, *args, **kwargs)
10781078
if result is None:
@@ -1934,14 +1934,14 @@ def _validate_freq(self):
19341934
"""
19351935
)
19361936

1937-
@Substitution(
1937+
@doc(
1938+
_shared_docs["aggregate"],
19381939
see_also=_agg_see_also_doc,
19391940
examples=_agg_examples_doc,
19401941
versionadded="",
19411942
klass="Series/Dataframe",
19421943
axis="",
19431944
)
1944-
@Appender(_shared_docs["aggregate"])
19451945
def aggregate(self, func, *args, **kwargs):
19461946
return super().aggregate(func, *args, **kwargs)
19471947

0 commit comments

Comments
 (0)