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.

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

Jump to bottom

docs: remove reference to sorting implementation #2114

Merged
merged 1 commit into from
Jan 12, 2023
Merged

docs: remove reference to sorting implementation #2114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 4 deletions src/awkward/operations/ak_argsort.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@ def argsort(
ascending (bool): If True, the first value in each sorted group
will be smallest, the last value largest; if False, the order
is from largest to smallest.
stable (bool): If True, use a stable sorting algorithm (introsort:
a hybrid of quicksort, heapsort, and insertion sort); if False,
use a sorting algorithm that is not guaranteed to be stable
(heapsort).
stable (bool): If True, use a stable sorting algorithm; if False,
use a sorting algorithm that is not guaranteed to be stable.
highlevel (bool): If True, return an #ak.Array; otherwise, return
a low-level #ak.contents.Content subclass.
behavior (None or dict): Custom #ak.behavior for the output array, if
Expand Down
6 changes: 2 additions & 4 deletions src/awkward/operations/ak_sort.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,8 @@ def sort(array, axis=-1, *, ascending=True, stable=True, highlevel=True, behavio
ascending (bool): If True, the first value in each sorted group
will be smallest, the last value largest; if False, the order
is from largest to smallest.
stable (bool): If True, use a stable sorting algorithm (introsort:
a hybrid of quicksort, heapsort, and insertion sort); if False,
use a sorting algorithm that is not guaranteed to be stable
(heapsort).
stable (bool): If True, use a stable sorting algorithm; if False,
use a sorting algorithm that is not guaranteed to be stable.
highlevel (bool): If True, return an #ak.Array; otherwise, return
a low-level #ak.contents.Content subclass.
behavior (None or dict): Custom #ak.behavior for the output array, if
Expand Down