DOC: Fix PR01 errors in multiple files (#57438) #57504
Merged
Conversation
This file contains 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
Fixed PR01 errors (pandas-dev#57438) and added parameter descriptions for: - `pandas.Grouper` - `pandas.core.groupby.DataFrameGroupBy.cummax` - `pandas.core.groupby.DataFrameGroupBy.cummin` - `pandas.core.groupby.DataFrameGroupBy.cumprod` - `pandas.core.groupby.DataFrameGroupBy.cumsum` - `pandas.core.groupby.DataFrameGroupBy.filter` - `pandas.core.groupby.DataFrameGroupBy.pct_change` - `pandas.core.groupby.DataFrameGroupBy.rolling` - `pandas.core.groupby.SeriesGroupBy.cummax` - `pandas.core.groupby.SeriesGroupBy.cummin` - `pandas.core.groupby.SeriesGroupBy.cumprod` - `pandas.core.groupby.SeriesGroupBy.cumsum` - `pandas.core.groupby.SeriesGroupBy.cumprod` Fixed functions also removed from code_checks.sh
Resolved a PR02 documentation error arising from the inherited `nunique` method docstring within `groupby.SeriesGroupBy.nunique`. The issue was due to the `resample.Resampler.nunique` method lacking a `dropna` parameter, which is present in the inherited docstring. - Introduced `_nunique_extra_params` to dynamically insert parameter documentation only where applicable (i.e. where `groupby.SeriesGroupBy.nunique`is).
mroeschke
reviewed
Feb 20, 2024
pandas/core/resample.py
Outdated
| @@ -1358,7 +1358,7 @@ def ohlc(self): | |||
| return self._downsample("ohlc") | |||
|
|
|||
| @final | |||
| @doc(SeriesGroupBy.nunique) | |||
| @doc(SeriesGroupBy.nunique, extra_params="") | |||
There was a problem hiding this comment.
Can you give this a distinct docstring (e.g. copy-paste the SeriesGroupBy.nunique docstring here) and avoid using doc?
There was a problem hiding this comment.
Sounds good. Since they're now their own distinct docstrings, I separated the examples too (added see alsos to each other instead)
mroeschke
reviewed
Feb 20, 2024
pandas/core/groupby/generic.py
Outdated
| """ | ||
| ) | ||
|
|
||
| @doc(extra_params=_nunique_extra_params) |
There was a problem hiding this comment.
Connecting with my other comment, can you avoid using doc here?
mroeschke
approved these changes
Feb 21, 2024
|
Thanks @Deen-dot |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
…#57504) * DOC: Fix PR01 errors in multiple files (pandas-dev#57438) Fixed PR01 errors (pandas-dev#57438) and added parameter descriptions for: - `pandas.Grouper` - `pandas.core.groupby.DataFrameGroupBy.cummax` - `pandas.core.groupby.DataFrameGroupBy.cummin` - `pandas.core.groupby.DataFrameGroupBy.cumprod` - `pandas.core.groupby.DataFrameGroupBy.cumsum` - `pandas.core.groupby.DataFrameGroupBy.filter` - `pandas.core.groupby.DataFrameGroupBy.pct_change` - `pandas.core.groupby.DataFrameGroupBy.rolling` - `pandas.core.groupby.SeriesGroupBy.cummax` - `pandas.core.groupby.SeriesGroupBy.cummin` - `pandas.core.groupby.SeriesGroupBy.cumprod` - `pandas.core.groupby.SeriesGroupBy.cumsum` - `pandas.core.groupby.SeriesGroupBy.cumprod` Fixed functions also removed from code_checks.sh * Updated formatting * Corrected E501 formatting * Remove trailing whitespaces * Fix PR02 error from docstring inheritance for resampler nunique method Resolved a PR02 documentation error arising from the inherited `nunique` method docstring within `groupby.SeriesGroupBy.nunique`. The issue was due to the `resample.Resampler.nunique` method lacking a `dropna` parameter, which is present in the inherited docstring. - Introduced `_nunique_extra_params` to dynamically insert parameter documentation only where applicable (i.e. where `groupby.SeriesGroupBy.nunique`is). * Resolve request * Undo mistake * Remove unnecessary import to fix ruff check
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.
Fixed PR01 errors (#57438) and added parameter descriptions for:
pandas.Grouperpandas.core.groupby.DataFrameGroupBy.cummaxpandas.core.groupby.DataFrameGroupBy.cumminpandas.core.groupby.DataFrameGroupBy.cumprodpandas.core.groupby.DataFrameGroupBy.cumsumpandas.core.groupby.DataFrameGroupBy.filterpandas.core.groupby.DataFrameGroupBy.pct_changepandas.core.groupby.DataFrameGroupBy.rollingpandas.core.groupby.SeriesGroupBy.nuniquepandas.core.groupby.SeriesGroupBy.cummaxpandas.core.groupby.SeriesGroupBy.cumminpandas.core.groupby.SeriesGroupBy.cumprodpandas.core.groupby.SeriesGroupBy.cumsumpandas.core.groupby.SeriesGroupBy.cumprodFixed functions also removed from code_checks.sh