diff options
Diffstat (limited to 'stdlib')
| -rw-r--r-- | stdlib/map.mli | 5 | ||||
| -rw-r--r-- | stdlib/set.mli | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/stdlib/map.mli b/stdlib/map.mli index 320db3f54..f6beef3c8 100644 --- a/stdlib/map.mli +++ b/stdlib/map.mli @@ -33,8 +33,9 @@ module type OrderedType = [f e1 e2] is zero if the keys [e1] and [e2] are equal, [f e1 e2] is strictly negative if [e1] is smaller than [e2], and [f e1 e2] is strictly positive if [e1] is greater than [e2]. - Example: a suitable ordering function is - the generic structural comparison function {!Pervasives.compare}. *) + Example: a suitable ordering function is the generic structural + comparison function {!Pervasives.compare}, provided there are + no floating-point NaN values in the data. *) end (** Input signature of the functor {!Map.Make}. *) diff --git a/stdlib/set.mli b/stdlib/set.mli index 7d4c32fd6..4de837b24 100644 --- a/stdlib/set.mli +++ b/stdlib/set.mli @@ -33,8 +33,9 @@ module type OrderedType = [f e1 e2] is zero if the elements [e1] and [e2] are equal, [f e1 e2] is strictly negative if [e1] is smaller than [e2], and [f e1 e2] is strictly positive if [e1] is greater than [e2]. - Example: a suitable ordering function is - the generic structural comparison function {!Pervasives.compare}. *) + Example: a suitable ordering function is the generic structural + comparison function {!Pervasives.compare}, provided there are + no floating-point NaN values in the data. *) end (** Input signature of the functor {!Set.Make}. *) |