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

docs: Ensure set_sorted description references single-column behavior #20709

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 3 additions & 3 deletions py-polars/polars/dataframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -11345,16 +11345,16 @@ def set_sorted(
descending: bool = False,
) -> DataFrame:
"""
Indicate that one or multiple columns are sorted.
Flag a column as sorted.

This can speed up future operations.

Parameters
----------
column
Column that are sorted
Column that is sorted
descending
Whether the columns are sorted in descending order.
Whether the column is sorted in descending order.

Warnings
--------
Expand Down
6 changes: 3 additions & 3 deletions py-polars/polars/lazyframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -6909,16 +6909,16 @@ def set_sorted(
descending: bool = False,
) -> LazyFrame:
"""
Indicate that one or multiple columns are sorted.
Flag a column as sorted.

This can speed up future operations.

Parameters
----------
column
Columns that are sorted
Column that is sorted
descending
Whether the columns are sorted in descending order.
Whether the column is sorted in descending order.

Warnings
--------
Expand Down
Loading