Skip to content

Commit 0e241cc

Browse files
authored
proposed rewording of the Ord instance documentation (#259)
Fixes #250.
1 parent 17127e0 commit 0e241cc

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

Data/HashMap/Base.hs

+3-5
Original file line numberDiff line numberDiff line change
@@ -403,11 +403,9 @@ instance Ord k => Ord1 (HashMap k) where
403403
liftCompare = cmp compare
404404
#endif
405405

406-
-- | The order is total.
407-
--
408-
-- /Note:/ Because the hash is not guaranteed to be stable across library
409-
-- versions, OSes, or architectures, neither is an actual order of elements in
410-
-- 'HashMap' or an result of `compare`.is stable.
406+
-- | The ordering is total and consistent with the `Eq` instance. However,
407+
-- nothing else about the ordering is specified, and it may change from
408+
-- version to version of either this package or of hashable.
411409
instance (Ord k, Ord v) => Ord (HashMap k v) where
412410
compare = cmp compare compare
413411

0 commit comments

Comments
 (0)