Skip to content

Commit 33910b0

Browse files
committed
added missing doc() decorators
1 parent e847e24 commit 33910b0

File tree

6 files changed

+21
-20
lines changed

6 files changed

+21
-20
lines changed

pandas/core/groupby/generic.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -237,14 +237,14 @@ def _selection_name(self):
237237
def apply(self, func, *args, **kwargs):
238238
return super().apply(func, *args, **kwargs)
239239

240-
@Substitution(
240+
@doc(
241+
_shared_docs["aggregate"],
241242
see_also=_agg_see_also_doc,
242243
examples=_agg_examples_doc,
243244
versionadded="",
244245
klass="Series",
245246
axis="",
246247
)
247-
@Appender(_shared_docs["aggregate"])
248248
def aggregate(self, func=None, *args, **kwargs):
249249

250250
relabeling = func is None
@@ -935,14 +935,14 @@ class DataFrameGroupBy(GroupBy[DataFrame]):
935935
"""
936936
)
937937

938-
@Substitution(
938+
@doc(
939+
_shared_docs["aggregate"],
939940
see_also=_agg_see_also_doc,
940941
examples=_agg_examples_doc,
941942
versionadded="",
942943
klass="DataFrame",
943944
axis="",
944945
)
945-
@Appender(_shared_docs["aggregate"])
946946
def aggregate(self, func=None, *args, **kwargs):
947947

948948
relabeling = func is None and is_multi_agg_with_relabel(**kwargs)

pandas/core/resample.py

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -3745,13 +3745,14 @@ def _gotitem(self, key, ndim, subset=None) -> "Series":
37453745
"""
37463746
)
37473747

3748-
@Substitution(
3748+
@doc(
3749+
generic._shared_docs["aggregate"],
3750+
klass=_shared_doc_kwargs["klass"],
3751+
axis=_shared_doc_kwargs["axis"],
37493752
see_also=_agg_see_also_doc,
37503753
examples=_agg_examples_doc,
37513754
versionadded="\n.. versionadded:: 0.20.0\n",
3752-
**_shared_doc_kwargs,
37533755
)
3754-
@Appender(generic._shared_docs["aggregate"])
37553756
def aggregate(self, func, axis=0, *args, **kwargs):
37563757
# Validate the axis parameter
37573758
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
@@ -114,14 +114,14 @@ def _get_window(self, other=None, **kwargs):
114114
"""
115115
)
116116

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

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:
@@ -1921,14 +1921,14 @@ def _validate_freq(self):
19211921
"""
19221922
)
19231923

1924-
@Substitution(
1924+
@doc(
1925+
_shared_docs["aggregate"],
19251926
see_also=_agg_see_also_doc,
19261927
examples=_agg_examples_doc,
19271928
versionadded="",
19281929
klass="Series/Dataframe",
19291930
axis="",
19301931
)
1931-
@Appender(_shared_docs["aggregate"])
19321932
def aggregate(self, func, *args, **kwargs):
19331933
return super().aggregate(func, *args, **kwargs)
19341934

0 commit comments

Comments
 (0)