Skip to content

Commit 86d6f2b

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.Grouper (#58273)
* fixed PR02,SA01 in docstring for pandas.Grouper * removed method pandas.Grouper * restored parameters for Grouper with an extra indentation * restored parameters and fixed See Also section * removed SA01 for pandas.Grouper
1 parent bb0fcc2 commit 86d6f2b

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

ci/code_checks.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
153153
-i "pandas.DatetimeTZDtype SA01" \
154154
-i "pandas.DatetimeTZDtype.tz SA01" \
155155
-i "pandas.DatetimeTZDtype.unit SA01" \
156-
-i "pandas.Grouper PR02,SA01" \
156+
-i "pandas.Grouper PR02" \
157157
-i "pandas.HDFStore.append PR01,SA01" \
158158
-i "pandas.HDFStore.get SA01" \
159159
-i "pandas.HDFStore.groups SA01" \

pandas/core/groupby/grouper.py

+5
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,11 @@ class Grouper:
117117
A TimeGrouper is returned if ``freq`` is not ``None``. Otherwise, a Grouper
118118
is returned.
119119
120+
See Also
121+
--------
122+
Series.groupby : Apply a function groupby to a Series.
123+
DataFrame.groupby : Apply a function groupby.
124+
120125
Examples
121126
--------
122127
``df.groupby(pd.Grouper(key="Animal"))`` is equivalent to ``df.groupby('Animal')``

0 commit comments

Comments
 (0)