[arrow-rs] branch master updated: Update sort kernel docs to not it is unstable (#572)

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new e3d4c6a  Update sort kernel docs to not it is unstable (#572)
e3d4c6a is described below

commit e3d4c6a8bc7ff05ca5a26ee9669cf0a6717ede0c
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Wed Jul 21 07:16:51 2021 -0400

    Update sort kernel docs to not it is unstable (#572)
---
 arrow/src/compute/kernels/sort.rs | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/arrow/src/compute/kernels/sort.rs b/arrow/src/compute/kernels/sort.rs
index 37c5e83..c1add67 100644
--- a/arrow/src/compute/kernels/sort.rs
+++ b/arrow/src/compute/kernels/sort.rs
@@ -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