DOC: Enforce Numpy Docstring Validation for pandas.Grouper #58273
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mroeschke
reviewed
Apr 16, 2024
mroeschke
reviewed
Apr 16, 2024
|
/preview |
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/58273/ |
mroeschke
reviewed
Apr 16, 2024
pandas/core/groupby/grouper.py
Outdated
Comment on lines
121
to
122
| See Also | ||
| ---------- |
There was a problem hiding this comment.
Suggested change
| See Also | |
| ---------- | |
| See Also | |
| -------- |
There was a problem hiding this comment.
I see. The number of - should be equal to the number of characters in the text including whitespace. Fixed it.
mroeschke
reviewed
Apr 16, 2024
pandas/core/groupby/grouper.py
Outdated
Comment on lines
123
to
124
| GroupBy : For grouping and aggregating relational data. | ||
| GroupByPlot : Class implementing the .plot attribute for groupby objects. |
There was a problem hiding this comment.
Suggested change
| GroupBy : For grouping and aggregating relational data. | |
| GroupByPlot : Class implementing the .plot attribute for groupby objects. | |
| Series.groupby : Apply a function groupby to a Series. | |
| DataFrame.groupby : Apply a function groupby. |
tuhinsharma121
commented
Apr 17, 2024
| @@ -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" \ | |||
There was a problem hiding this comment.
I have kept the PR02 else the CI fails.
mroeschke
approved these changes
Apr 17, 2024
|
Thanks @tuhinsharma121 |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
…v#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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.