# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1565199830 -7200
# Node ID c09da4ee177f41c3fbfe20cbc515929d3dc73571
# Parent  8f0a3c00d1d2be60a87dae84321f9b25dd54c8bf
adjusts the documentation for ucx_array_sort() to the current plans

diff -r 8f0a3c00d1d2 -r c09da4ee177f src/ucx/array.h
--- a/src/ucx/array.h	Tue Aug 06 16:26:46 2019 +0200
+++ b/src/ucx/array.h	Wed Aug 07 19:43:50 2019 +0200
@@ -234,16 +234,12 @@
 /**
  * Sorts a UcxArray with the best available sort algorithm.
  * 
- * If present, qsort_s() will be used. Otherwise, if no additional data is
- * specified, qsort() is used as a fall back.
- * 
- * If qsort_s() is not available and <code>data</code> is not <code>NULL</code>,
- * a custom almost in-place merge sort algorithm is used, which uses additional
- * memory for exactly one element.
+ * A merge sort algorithm is used, which is guaranteed to use no more additional
+ * memory than for exactly one element.
  * 
  * @param array the array to sort
  * @param cmpfnc the function that shall be used to compare the element data
- * @param data additional data for the cmp_func()
+ * @param data additional data for the cmp_func() or <code>NULL</code>
  */
 void ucx_array_sort(UcxArray array, cmp_func cmpfnc, void *data);