Skip to content

Doc: fixed missing behavior explaination of sort=false for groupby issue #47529 #52736

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 7 commits into from
Apr 21, 2023
Merged

Doc: fixed missing behavior explaination of sort=false for groupby issue #47529 #52736

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
740d0b4
fix issue 47529
raanasn Apr 18, 2023
128574c
add info for sort=false in groupby.rst
raanasn Apr 18, 2023
f936ea8
fixed pre-commit problem
raanasn Apr 18, 2023
5c45249
Update pandas/core/shared_docs.py for groupby sort
raanasn Apr 19, 2023
a22b275
Merge branch 'main' into DOC--missed-behavior-explaination-of-sort=Fa…
raanasn Apr 20, 2023
182dc2b
removed additional space in groupby.rst
raanasn Apr 20, 2023
6e7af9c
Merge branch 'main' into DOC--missed-behavior-explaination-of-sort=Fa…
raanasn Apr 20, 2023
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
4 changes: 2 additions & 2 deletions doc/source/user_guide/groupby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ only verifies that you've passed a valid mapping.
GroupBy sorting
~~~~~~~~~~~~~~~~~~~~~~~~~

By default the group keys are sorted during the ``groupby`` operation. You may however pass ``sort=False`` for potential speedups:
By default the group keys are sorted during the ``groupby`` operation. You may however pass ``sort=False`` for potential speedups. With ``sort=False`` the order among group-keys follows the order of appearance of the keys in the original dataframe:

.. ipython:: python

Expand All @@ -205,7 +205,7 @@ By default the group keys are sorted during the ``groupby`` operation. You may h
df2.groupby(["X"], sort=False).sum()


Note that ``groupby`` will preserve the order in which *observations* are sorted *within* each group.
Note that ``groupby`` will preserve the order in which *observations* are sorted *within* each group .
Copy link
Member

Choose a reason for hiding this comment

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

why make this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In the comments of the issue it was mentioned to add also a description in the "User Guide".

Copy link
Member

Choose a reason for hiding this comment

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

@raanasn - it looks like you're adding an unnecessary space before the period here.

Copy link
Member

Choose a reason for hiding this comment

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

exactly - if you revert this the rest look good to me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Typo, thanks!!

For example, the groups created by ``groupby()`` below are in the order they appeared in the original ``DataFrame``:

.. ipython:: python
Expand Down
4 changes: 3 additions & 1 deletion pandas/core/shared_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,9 @@
sort : bool, default True
Sort group keys. Get better performance by turning this off.
Note this does not influence the order of observations within each
group. Groupby preserves the order of rows within each group.
group. Groupby preserves the order of rows within each group. If False
the order among groups with their keys follows the order of appearance
of the keys in the original dataframe.
This argument has no effect on filtrations (see the `filtrations in the user guide
<https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration>`_),
such as ``head()``, ``tail()``, ``nth()`` and in transformations
Expand Down