Skip to content

DOC: sort has no effect on filters #51825

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
Mar 10, 2023
Merged

DOC: sort has no effect on filters #51825

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fe1bf42
DOC: sort has no effect on filters
natmokval Mar 7, 2023
c77d050
DOC: update docs ref
natmokval Mar 8, 2023
b89c6e8
Merge branch 'main' into 51692-groupby-sort
natmokval Mar 8, 2023
c1cfc4a
DOC: as_index has no effect on filters
natmokval Mar 9, 2023
a0cb065
Merge branch 'main' into 51692-groupby-sort
natmokval Mar 9, 2023
63dd4d6
DOC: change duplicate target name
natmokval Mar 9, 2023
f6b2d68
DOC: sort and as_index have no effect in transformations
natmokval Mar 9, 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
8 changes: 7 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 @@ -114,11 +114,17 @@
as_index : bool, default True
For aggregated output, return object with group labels as the
Copy link
Member

Choose a reason for hiding this comment

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

With your addition (if we add in transformations, see below), I think "For aggregated output," can be removed. But I'm also okay with it staying as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed "For aggregated output,". With my addition, there is no need to write this.

index. Only relevant for DataFrame input. as_index=False is
effectively "SQL-style" grouped output.
effectively "SQL-style" grouped output. This argument has no effect
on filtrations (see the `filtration user guide
<https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration>`_),
such as ``head()``, ``tail()`` and ``nth()``.
Copy link
Member

Choose a reason for hiding this comment

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

Can you add in transformations here as well?

I would describe it as "filtrations in the user guide" rather than "filteration user guide"; what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree, "filtrations in the user guide" sounds more correct and more clear.

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.
This argument has no effect on filtrations (see the `filtration user guide
<https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration>`_),
such as ``head()``, ``tail()`` and ``nth()``.
Copy link
Member

Choose a reason for hiding this comment

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

Similar remarks here.


.. versionchanged:: 2.0.0

Expand Down