Library docs: Document the order for sort and sortOn.
authorAlexander Kjeldaas <ak@formalprivacy.com>
Wed, 8 Feb 2017 23:26:02 +0000 (00:26 +0100)
committerJoachim Breitner <mail@joachim-breitner.de>
Thu, 9 Feb 2017 18:15:54 +0000 (13:15 -0500)
This closes GH-22.

libraries/base/Data/OldList.hs

index c3618c4..428d3bd 100644 (file)
@@ -815,6 +815,9 @@ permutations xs0        =  xs0 : perms xs0 []
 -- | The 'sort' function implements a stable sorting algorithm.
 -- It is a special case of 'sortBy', which allows the programmer to supply
 -- their own comparison function.
+--
+-- Elements are arranged from from lowest to highest, keeping duplicates in
+-- the order they appeared in the input.
 sort :: (Ord a) => [a] -> [a]
 
 -- | The 'sortBy' function is the non-overloaded version of 'sort'.
@@ -978,6 +981,9 @@ rqpart cmp x (y:ys) rle rgt r =
 -- input list.  This is called the decorate-sort-undecorate paradigm, or
 -- Schwartzian transform.
 --
+-- Elements are arranged from from lowest to highest, keeping duplicates in
+-- the order they appeared in the input.
+--
 -- @since 4.8.0.0
 sortOn :: Ord b => (a -> b) -> [a] -> [a]
 sortOn f =