Skip to content

Commit 1dce67c

Browse files
authored
DOC: Parameter doc strings for Groupby.(sum|prod|min|max|first|last) (pandas-dev#31486)
1 parent 298fc15 commit 1dce67c

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

pandas/core/groupby/groupby.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -1351,13 +1351,22 @@ def groupby_function(
13511351
_local_template = """
13521352
Compute %(f)s of group values.
13531353
1354+
Parameters
1355+
----------
1356+
numeric_only : bool, default %(no)s
1357+
Include only float, int, boolean columns. If None, will attempt to use
1358+
everything, then use only numeric data.
1359+
min_count : int, default %(mc)s
1360+
The required number of valid values to perform the operation. If fewer
1361+
than ``min_count`` non-NA values are present the result will be NA.
1362+
13541363
Returns
13551364
-------
13561365
Series or DataFrame
13571366
Computed %(f)s of values within each group.
13581367
"""
13591368

1360-
@Substitution(name="groupby", f=name)
1369+
@Substitution(name="groupby", f=name, no=numeric_only, mc=min_count)
13611370
@Appender(_common_see_also)
13621371
@Appender(_local_template)
13631372
def func(self, numeric_only=numeric_only, min_count=min_count):

0 commit comments

Comments
 (0)