Skip to content

Commit

Permalink
Update sort kernel docs to not it is unstable (#572)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb authored Jul 21, 2021
1 parent 68a4b5b commit e3d4c6a
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions arrow/src/compute/kernels/sort.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,15 @@ use TimeUnit::*;

/// Sort the `ArrayRef` using `SortOptions`.
///
/// Performs a stable sort on values and indices. Nulls are ordered according to the `nulls_first` flag in `options`.
/// Floats are sorted using IEEE 754 totalOrder
/// Performs a sort on values and indices. Nulls are ordered according
/// to the `nulls_first` flag in `options`. Floats are sorted using
/// IEEE 754 totalOrder
///
/// Returns an `ArrowError::ComputeError(String)` if the array type is either unsupported by `sort_to_indices` or `take`.
/// Returns an `ArrowError::ComputeError(String)` if the array type is
/// either unsupported by `sort_to_indices` or `take`.
///
/// Note: this is an unstable_sort, meaning it may not preserve the
/// order of equal elements.
///
/// # Example
/// ```rust
Expand Down

0 comments on commit e3d4c6a

Please sign in to comment.