DOC: Improve groupby in the User Guide #51704

rhshadrach · 2023-03-01T02:48:39Z

closes #xxxx (Replace xxxx with the GitHub issue number)
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

Reworks the aggregation, transformation, and filtration sections of the groupby user guide. The primary change is a greater emphasis on built-in methods and warning users that supplying UDFs to agg, transform, and filter is inefficient.

…pby_userguide # Conflicts: # doc/source/user_guide/groupby.rst

…pby_userguide

MarcoGorelli

Nice! Still need to properly read everything, but this looks like a really nice improvement

cc @DeaMariaLeon @natmokval in case you want to have a look (tagging you as you've both done several docs issues, so this may be of interest - no obligation though!)

DeaMariaLeon · 2023-03-02T18:41:19Z

I think I should just comment on Richard's edits, but since I have to read the whole document (to be able to understand) I may as well suggest other edits.
So I converted Richard's document to html, and I'm attaching it as a pdf file. It has my first suggestions.
I'm just in the middle of the document.

Should I contribute my edits? If so, in this PR or in a separate PR?
Group by - documentation.pdf

@MarcoGorelli @rhshadrach

rhshadrach

Thanks @DeaMariaLeon! Since this PR only touches aggregation, transformation, and filtration, I think we should separate off any requested changes outside of these sections into a separate PR. Would you be up for putting one up?

I've taken your comments and added them inline here. For some, I made comments after them. If there is no comment, then I'm +1 on making the change. If you'd like to push them to this branch, that'd work for me; otherwise I can make them directly - good either way just let me know.

For the ones that have comments after, we should discuss further before making changes.

doc/source/user_guide/groupby.rst

DeaMariaLeon · 2023-03-03T14:39:32Z

I think we should separate off any requested changes outside of these sections into a separate PR. Would you be up for putting one up?

Sure

If you'd like to push them to this branch, that'd work for me; otherwise I can make them directly - good either way just let me know.

Yes, I can (try) to do the push... I will now edit the things for which you were "+1".

DeaMariaLeon · 2023-03-03T17:51:24Z

@rhshadrach I did a PR to your branch.

DOC Checking groupby guide

…pby_userguide � Conflicts: � doc/source/user_guide/groupby.rst

rhshadrach · 2023-03-04T13:11:42Z

Thanks @DeaMariaLeon - I merged your branch. A few of your comments remain to discuss; can you go through those above and let me know your thoughts.

DeaMariaLeon · 2023-03-04T15:08:04Z

@rhshadrach sorry I didn't comment earlier. It's just that I didn't see a problem.

I will open a PR, as I said, with edits to the same document but on different sections.

rhshadrach · 2023-03-04T20:33:13Z

@MarcoGorelli - I think this is ready for review. @phofl - I believe you said you were planning to take a look.

phofl

small comments

doc/source/user_guide/groupby.rst

…pby_userguide

phofl

Looks good to me

phofl · 2023-03-07T22:44:56Z

doc/source/user_guide/groupby.rst

+        :meth:`~.DataFrameGroupBy.cov` * ;Compute the covariance of the groups
+        :meth:`~.DataFrameGroupBy.first`;Compute the first occurring value in each group
+        :meth:`~.DataFrameGroupBy.idxmax` *;Compute the index of the maximum value in each group
+        :meth:`~.DataFrameGroupBy.idxmin` *;Compute the index of the minimum value in each group


This looks weird, does this render properly?

mroeschke · 2023-03-08T21:36:06Z

Nice improvements!

lumberbot-app · 2023-03-08T21:36:26Z

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout 2.0.x
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 ff9c8f4a56c243d4d7c101ed9d9d1da322eb5c59

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #51704: DOC: Improve groupby in the User Guide'

Push to a named branch:

git push YOURFORK 2.0.x:auto-backport-of-pr-51704-on-2.0.x

Create a PR against branch 2.0.x, I would have named this PR:

"Backport PR #51704 on branch 2.0.x (DOC: Improve groupby in the User Guide)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

MarcoGorelli · 2023-03-09T10:44:06Z

@MarcoGorelli - I think this is ready for review. @phofl - I believe you said you were planning to take a look.

apologies for not getting to this in time - great work anyway, I've done the backport

…Guide) (#51857) Backport PR #51704: DOC: Improve groupby in the User Guide Co-authored-by: Richard Shadrach <45562402+rhshadrach@users.noreply.github.com>

rhshadrach added 4 commits February 24, 2023 18:10

DOC: Overhaul groupby.rst in the User Guide

bcdbf73

Merge branch 'main' of https://github.com/pandas-dev/pandas into grou…

2886fcc

…pby_userguide # Conflicts: # doc/source/user_guide/groupby.rst

Merge branch 'main' of https://github.com/pandas-dev/pandas into grou…

d457738

…pby_userguide

Improvements

fc158ee

rhshadrach added Docs Groupby labels Mar 1, 2023

rhshadrach added this to the 2.0 milestone Mar 1, 2023

MarcoGorelli reviewed Mar 1, 2023

View reviewed changes

MarcoGorelli self-requested a review March 1, 2023 20:12

rhshadrach commented Mar 2, 2023

View reviewed changes

DOC Checking groupby guide

4363397

DeaMariaLeon mentioned this pull request Mar 3, 2023

DOC Checking groupby guide rhshadrach/pandas#3

Merged

rhshadrach and others added 3 commits March 4, 2023 08:01

Merge pull request #3 from DeaMariaLeon/checkgroupby

5b00d88

DOC Checking groupby guide

Fix as_index language

7d28a97

Merge branch 'main' of https://github.com/pandas-dev/pandas into grou…

6d72b34

…pby_userguide � Conflicts: � doc/source/user_guide/groupby.rst

phofl reviewed Mar 5, 2023

View reviewed changes

rhshadrach added 2 commits March 5, 2023 15:37

Merge branch 'main' of https://github.com/pandas-dev/pandas into grou…

c7f88d3

…pby_userguide

Improvements

ec0d5f8

rhshadrach requested a review from phofl March 6, 2023 02:10

rhshadrach mentioned this pull request Mar 6, 2023

groupby weird behavior #51692

Closed

phofl approved these changes Mar 7, 2023

View reviewed changes

phofl reviewed Mar 7, 2023

View reviewed changes

mroeschke approved these changes Mar 8, 2023

View reviewed changes

mroeschke merged commit ff9c8f4 into pandas-dev:main Mar 8, 2023

lumberbot-app bot added the Still Needs Manual Backport label Mar 8, 2023

MarcoGorelli pushed a commit to MarcoGorelli/pandas that referenced this pull request Mar 9, 2023

Backport PR pandas-dev#51704: DOC: Improve groupby in the User Guide

b7ee049

MarcoGorelli removed the Still Needs Manual Backport label Mar 9, 2023

DeaMariaLeon mentioned this pull request Mar 12, 2023

DOC Trying to improve Group by split-apply-combine guide #51916

Merged

5 tasks

rhshadrach deleted the groupby_userguide branch April 2, 2023 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Improve groupby in the User Guide #51704

DOC: Improve groupby in the User Guide #51704

rhshadrach commented Mar 1, 2023 •

edited

Loading

MarcoGorelli left a comment

DeaMariaLeon commented Mar 2, 2023

rhshadrach left a comment •

edited

Loading

DeaMariaLeon commented Mar 3, 2023

DeaMariaLeon commented Mar 3, 2023

rhshadrach commented Mar 4, 2023

DeaMariaLeon commented Mar 4, 2023

rhshadrach commented Mar 4, 2023

phofl left a comment

phofl left a comment

phofl Mar 7, 2023

rhshadrach Mar 8, 2023

mroeschke commented Mar 8, 2023

lumberbot-app bot commented Mar 8, 2023

MarcoGorelli commented Mar 9, 2023

DOC: Improve groupby in the User Guide #51704

DOC: Improve groupby in the User Guide #51704

Conversation

rhshadrach commented Mar 1, 2023 • edited Loading

MarcoGorelli left a comment

Choose a reason for hiding this comment

DeaMariaLeon commented Mar 2, 2023

rhshadrach left a comment • edited Loading

Choose a reason for hiding this comment

DeaMariaLeon commented Mar 3, 2023

DeaMariaLeon commented Mar 3, 2023

rhshadrach commented Mar 4, 2023

DeaMariaLeon commented Mar 4, 2023

rhshadrach commented Mar 4, 2023

phofl left a comment

Choose a reason for hiding this comment

phofl left a comment

Choose a reason for hiding this comment

phofl Mar 7, 2023

Choose a reason for hiding this comment

rhshadrach Mar 8, 2023

Choose a reason for hiding this comment

mroeschke commented Mar 8, 2023

lumberbot-app bot commented Mar 8, 2023

MarcoGorelli commented Mar 9, 2023

rhshadrach commented Mar 1, 2023 •

edited

Loading

rhshadrach left a comment •

edited

Loading