Skip to content
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.

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

DOC: Add SeriesGroupBy and DataFrameGroupBy reference pages #48500

Merged
merged 7 commits into from
Sep 15, 2022

Conversation

rhshadrach
Copy link
Member

I grepped py / rst files for any references to GroupBy.:

grep results
grep -rl --include \*.rst --include \*.py "[^se]GroupBy\."

pandas/core/sample.py
pandas/core/resample.py
pandas/core/apply.py
pandas/core/groupby/grouper.py
pandas/core/groupby/groupby.py
pandas/core/groupby/indexing.py
pandas/tests/plotting/test_groupby.py
pandas/tests/groupby/test_indexing.py
pandas/tests/groupby/test_pipe.py
doc/source/whatsnew/v1.0.1.rst
doc/source/whatsnew/v0.18.0.rst
doc/source/whatsnew/v0.25.2.rst
doc/source/whatsnew/v1.0.4.rst
doc/source/whatsnew/v0.21.0.rst
doc/source/whatsnew/v0.14.0.rst
doc/source/whatsnew/v1.4.0.rst
doc/source/whatsnew/v0.20.0.rst
doc/source/whatsnew/v1.3.3.rst
doc/source/whatsnew/v1.5.0.rst
doc/source/whatsnew/v0.24.2.rst
doc/source/whatsnew/v1.1.5.rst
doc/source/whatsnew/v1.2.1.rst
doc/source/whatsnew/v0.16.1.rst
doc/source/whatsnew/v1.1.4.rst
doc/source/whatsnew/v0.16.2.rst
doc/source/whatsnew/v0.20.2.rst
doc/source/whatsnew/v0.23.1.rst
doc/source/whatsnew/v1.3.0.rst
doc/source/whatsnew/v1.0.0.rst
doc/source/whatsnew/v0.25.0.rst
doc/source/whatsnew/v0.24.0.rst
doc/source/whatsnew/v1.1.0.rst
doc/source/whatsnew/v0.25.1.rst
doc/source/whatsnew/v1.3.5.rst
doc/source/whatsnew/v1.3.4.rst
doc/source/whatsnew/v1.6.0.rst
doc/source/whatsnew/v0.23.0.rst
doc/source/whatsnew/v1.2.0.rst
doc/source/whatsnew/v0.14.1.rst
doc/source/whatsnew/v0.15.0.rst
doc/source/whatsnew/v0.18.1.rst
doc/source/whatsnew/v1.0.2.rst

Looking through the py files, all remaining references are internal. This only leaves what to do with the whatsnew files. I could

  • replace all occurrences;
  • replace all occurrences in 1.x files;
  • replace all occurrences in 1.4/1.5/1.6 files;
  • leave any past whatsnews alone

Any thoughts @mroeschke?

@mroeschke
Copy link
Member

If there's not too many occurrences, it would be great to replace all the occurrences in the whatsnew files (I've wanted to do this for other references too but low priority). Otherwise, might be good just to do the recent ones (1.4/1.5/1.6).

@rhshadrach rhshadrach marked this pull request as ready for review September 15, 2022 02:40
@mroeschke mroeschke merged commit ac648ee into pandas-dev:main Sep 15, 2022
@mroeschke
Copy link
Member

Nice! Thanks @rhshadrach

@rhshadrach rhshadrach deleted the groupby_api_docs branch September 16, 2022 00:00
@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
…ev#48500)

* WIP

* DOC: Add SeriesGroupBy and DataFrameGroupBy reference pages

* whatnews, fix docstring of filter

* Reorder docstring sections
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Include SeriesGroupBy ops in API docs
2 participants