[project @ 2002-06-13 10:41:31 by simonmar]

Some extra docs, from Jon Fairbairn

1 files changed, 13 insertions, 0 deletions

diff --git a/libraries/base/Data/FiniteMap.hs b/libraries/base/Data/FiniteMap.hs
index 244b811437..1a08cae9e8 100644
--- a/libraries/base/Data/FiniteMap.hs
+++ b/libraries/base/Data/FiniteMap.hs
@@ -210,8 +210,21 @@ lookupWithDefaultFM
 		-- to return for an unmapped key
 
 --	LISTIFYING
+
+-- | Convert a 'FiniteMap' to a @[(key, elt)]@ sorted by 'Ord' key
+--
 fmToList	:: FiniteMap key elt -> [(key,elt)]
+
+-- | Extract the keys from a 'FiniteMap', in the order of the keys, so
+--
+-- > keysFM == map fst . fmToList
+--
 keysFM		:: FiniteMap key elt -> [key]
+
+-- | Extract the elements from a 'FiniteMap', in the order of the keys, so
+--
+-- > eltsFM == map snd . fmToList
+--
 eltsFM		:: FiniteMap key elt -> [elt]
 
 -- ---------------------------------------------------------------------------