Skip to content

DOC: Add rolling in reference/groupby.rst #51119

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

Jump to bottom
Merged
merged 8 commits into from
Feb 8, 2023
Merged

DOC: Add rolling in reference/groupby.rst #51119

merged 8 commits into from
Feb 8, 2023

Conversation

@luke396
Copy link
Contributor

@luke396 luke396 commented Feb 2, 2023 •
edited
Loading

@mroeschke
Copy link
Member

mroeschke commented Feb 2, 2023

Since we have docstring checks, the docstrings of these will need to be improved in this PR

Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:RT01:pandas.core.groupby.DataFrameGroupBy.rolling:No Returns section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:RT01:pandas.core.groupby.SeriesGroupBy.rolling:No Returns section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:EX01:pandas.core.groupby.DataFrameGroupBy.rolling:No examples section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:EX01:pandas.core.groupby.SeriesGroupBy.rolling:No examples section found
@mroeschke mroeschke added Docs Groupby Window rolling, ewma, expanding labels Feb 2, 2023
@luke396
Copy link
Contributor Author

luke396 commented Feb 3, 2023

Since we have docstring checks, the docstrings of these will need to be improved in this PR

Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:RT01:pandas.core.groupby.DataFrameGroupBy.rolling:No Returns section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:RT01:pandas.core.groupby.SeriesGroupBy.rolling:No Returns section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:EX01:pandas.core.groupby.DataFrameGroupBy.rolling:No examples section found Error: /home/runner/work/pandas/pandas/pandas/core/groupby/groupby.py:2787:EX01:pandas.core.groupby.SeriesGroupBy.rolling:No examples section found

I added some docstring, but they definitely need further discussion.

The parameters section is copied from pandas.DataFrame.rolling, the parameter step is not implemented, so I removed it. Other parameters are implemented, but the exact description I'm not sure if I need to keep changing.
@luke396 luke396 marked this pull request as ready for review February 4, 2023 03:36
mroeschke
mroeschke reviewed Feb 6, 2023
View reviewed changes
mroeschke
mroeschke reviewed Feb 7, 2023
View reviewed changes
@mroeschke mroeschke added this to the 2.0 milestone Feb 8, 2023
@mroeschke mroeschke merged commit f9ce6f0 into pandas-dev:main Feb 8, 2023
@mroeschke
Copy link
Member

mroeschke commented Feb 8, 2023

Thanks @luke396
@luke396 luke396 deleted the add-doc-groupy.rolling branch February 9, 2023 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Groupby Window rolling, ewma, expanding

2 participants

@luke396 @mroeschke