Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Grouper #58273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 17, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Grouper #58273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d991fed
fixed PR02,SA01 in docstring for pandas.Grouper
tuhinsharma121 Apr 16, 2024
9e56513
removed method pandas.Grouper
tuhinsharma121 Apr 16, 2024
748c752
restored parameters for Grouper with an extra indentation
tuhinsharma121 Apr 16, 2024
a6e5c77
restored parameters and fixed See Also section
tuhinsharma121 Apr 17, 2024
5764f9f
removed SA01 for pandas.Grouper
tuhinsharma121 Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DatetimeTZDtype SA01" \
-i "pandas.DatetimeTZDtype.tz SA01" \
-i "pandas.DatetimeTZDtype.unit SA01" \
-i "pandas.Grouper PR02,SA01" \
-i "pandas.Grouper PR02" \
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have kept the PR02 else the CI fails.

-i "pandas.HDFStore.append PR01,SA01" \
-i "pandas.HDFStore.get SA01" \
-i "pandas.HDFStore.groups SA01" \
Expand Down
5 changes: 5 additions & 0 deletions pandas/core/groupby/grouper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,11 @@ class Grouper:
A TimeGrouper is returned if ``freq`` is not ``None``. Otherwise, a Grouper
is returned.

See Also
--------
Series.groupby : Apply a function groupby to a Series.
DataFrame.groupby : Apply a function groupby.

Examples
--------
``df.groupby(pd.Grouper(key="Animal"))`` is equivalent to ``df.groupby('Animal')``
Expand Down