Skip to content

DOC: Add clarification to groupby docs regarding hashes and equality #57648

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

Merged
merged 3 commits into from
Mar 6, 2024
Merged

DOC: Add clarification to groupby docs regarding hashes and equality #57648

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1faa00
Add clarification to groupby docs regarding hashes and equality
gabuzi Feb 27, 2024
6d0ee41
Merge branch 'pandas-dev:main' into clarify-groupby-docs-hash
gabuzi Mar 6, 2024
8d1b299
shared_docs.py: Move hash-based note below user guide link
gabuzi Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions pandas/core/shared_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,12 @@
Notes
-----
The implementation of groupby is hash-based, meaning in particular that
Copy link
Member

@rhshadrach rhshadrach Feb 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move this below the other note? I think the link to the user guide should be the most prominent. It's not a big deal right now, but would be if this section gets expanded more on in the future.

Copy link
Contributor Author

@gabuzi gabuzi Mar 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review! Will do.

objects that compare as equal will be considered to be in the same group.
An exception to this is that pandas has special handling of NA values:
any NA values will be collapsed to a single group, regardless of how
they compare. See the user guide linked below for more details.
See the `user guide
<https://pandas.pydata.org/pandas-docs/stable/groupby.html>`__ for more
detailed usage and examples, including splitting an object into groups,
Expand Down