Skip to content

Commit 7d433c0

Browse files
committed
added missing doc() decorators
1 parent 676820e commit 7d433c0

File tree

6 files changed

+25
-21
lines changed

6 files changed

+25
-21
lines changed

pandas/core/groupby/generic.py

+8-5
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(
@@ -915,10 +917,11 @@ class DataFrameGroupBy(GroupBy[DataFrame]):
915917
See :ref:`groupby.aggregate.named` for more."""
916918
)
917919

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

pandas/core/resample.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -269,14 +269,14 @@ def pipe(self, func, *args, **kwargs):
269269
"""
270270
)
271271

272-
@Substitution(
272+
@doc(
273+
_shared_docs["aggregate"],
273274
see_also=_agg_see_also_doc,
274275
examples=_agg_examples_doc,
275276
versionadded="",
276277
klass="DataFrame",
277278
axis="",
278279
)
279-
@Appender(_shared_docs["aggregate"])
280280
def aggregate(self, func, *args, **kwargs):
281281

282282
self._set_binner()

pandas/core/series.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -3848,13 +3848,14 @@ def _gotitem(self, key, ndim, subset=None) -> "Series":
38483848
"""
38493849
)
38503850

3851-
@Substitution(
3851+
@doc(
3852+
generic._shared_docs["aggregate"],
3853+
klass=_shared_doc_kwargs["klass"],
3854+
axis=_shared_doc_kwargs["axis"],
38523855
see_also=_agg_see_also_doc,
38533856
examples=_agg_examples_doc,
38543857
versionadded="\n.. versionadded:: 0.20.0\n",
3855-
**_shared_doc_kwargs,
38563858
)
3857-
@Appender(generic._shared_docs["aggregate"])
38583859
def aggregate(self, func, axis=0, *args, **kwargs):
38593860
# Validate the axis parameter
38603861
self._get_axis_number(axis)

pandas/core/window/ewm.py

+3-3
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

+3-3
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

+5-5
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)