Merge pull request elm#436 from jvoigtlaender/dicts-ordered

Documentation: Express order in Dict/Set enumeration functions
ThomasWeiser · Nov 28, 2015 · 033fe1f · 033fe1f
2 parents 624907f + 0a08c2b
commit 033fe1f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/Dict.elm b/src/Dict.elm
@@ -540,7 +540,7 @@ diff t1 t2 =
   foldl (\k v t -> remove k t) t1 t2
 
 
-{-| Get all of the keys in a dictionary.
+{-| Get all of the keys in a dictionary, sorted from lowest to highest.
 
     keys (fromList [(0,"Alice"),(1,"Bob")]) == [0,1]
 -}
@@ -549,7 +549,7 @@ keys dict =
   foldr (\key value keyList -> key :: keyList) [] dict
 
 
-{-| Get all of the values in a dictionary.
+{-| Get all of the values in a dictionary, in the order of their keys.
 
     values (fromList [(0,"Alice"),(1,"Bob")]) == ["Alice", "Bob"]
 -}
@@ -558,7 +558,7 @@ values dict =
   foldr (\key value valueList -> value :: valueList) [] dict
 
 
-{-| Convert a dictionary into an association list of key-value pairs. -}
+{-| Convert a dictionary into an association list of key-value pairs, sorted by keys. -}
 toList : Dict comparable v -> List (comparable,v)
 toList dict =
   foldr (\key value list -> (key,value) :: list) [] dict

diff --git a/src/Set.elm b/src/Set.elm
@@ -118,7 +118,7 @@ diff (Set_elm_builtin d1) (Set_elm_builtin d2) =
   Set_elm_builtin <| Dict.diff d1 d2
 
 
-{-| Convert a set into a list.
+{-| Convert a set into a list, sorted from lowest to highest.
 -}
 toList : Set comparable -> List comparable
 toList (Set_elm_builtin d) =