summaryrefslogtreecommitdiff
path: root/stdlib/array.mli
diff options
context:
space:
mode:
authorDamien Doligez <damien.doligez-inria.fr>2002-05-16 15:09:09 +0000
committerDamien Doligez <damien.doligez-inria.fr>2002-05-16 15:09:09 +0000
commit4b981e1964f31fc2027ce8f4dc4a2935deeb4daf (patch)
tree6ecd2fbb290f6cab91dd44acf0ad1911a18597c2 /stdlib/array.mli
parent3901fe23011c852b7dbdf5850888c3375d488902 (diff)
downloadocaml-4b981e1964f31fc2027ce8f4dc4a2935deeb4daf.tar.gz
documentation de sort
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@4818 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'stdlib/array.mli')
-rw-r--r--stdlib/array.mli3
1 files changed, 2 insertions, 1 deletions
diff --git a/stdlib/array.mli b/stdlib/array.mli
index 2a4d3628a6..3d0c31895e 100644
--- a/stdlib/array.mli
+++ b/stdlib/array.mli
@@ -162,7 +162,8 @@ val sort : ('a -> 'a -> int) -> 'a array -> unit
compare as equal, a positive integer if the first is greater,
and a negative integer if the first is smaller (see below for a
complete specification). For example, {!Pervasives.compare} is
- a suitable comparison function. After calling [Array.sort], the
+ a suitable comparison function, provided there are no floating-point
+ NaN values in the data. After calling [Array.sort], the
array is sorted in place in increasing order.
[Array.sort] is guaranteed to run in constant heap space
and (at most) logarithmic stack space.