Skip to content

Commit ad9096f

Browse files
committed
added missing doc() decorators
1 parent e476667 commit ad9096f

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(
@@ -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

Lines changed: 2 additions & 2 deletions
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

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

3864-
@Substitution(
3864+
@doc(
3865+
generic._shared_docs["aggregate"],
3866+
klass=_shared_doc_kwargs["klass"],
3867+
axis=_shared_doc_kwargs["axis"],
38653868
see_also=_agg_see_also_doc,
38663869
examples=_agg_examples_doc,
38673870
versionadded="\n.. versionadded:: 0.20.0\n",
3868-
**_shared_doc_kwargs,
38693871
)
3870-
@Appender(generic._shared_docs["aggregate"])
38713872
def aggregate(self, func, axis=0, *args, **kwargs):
38723873
# Validate the axis parameter
38733874
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
@@ -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,
@@ -1150,14 +1150,14 @@ def _get_window(
11501150
"""
11511151
)
11521152

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

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

0 commit comments

Comments
 (0)