Documentation improvements, whitespace cleaning.
authorMilan Straka <fox@ucw.cz>
Wed, 4 Dec 2013 18:30:45 +0000 (19:30 +0100)
committerMilan Straka <fox@ucw.cz>
Wed, 4 Dec 2013 18:30:45 +0000 (19:30 +0100)
Data/IntMap/Base.hs
Data/IntSet/Base.hs
Data/Map/Base.hs
Data/Set/Base.hs

index 08448dd..ebdbc12 100644 (file)
@@ -2086,14 +2086,15 @@ foldlStrict f = go
 -- relationships of the output subsets.
 --
 -- Examples:
---     
+--
 -- > splitRoot (fromList (zip [1..6::Int] ['a'..])) ==
 -- >   [fromList [(1,'a'),(2,'b'),(3,'c')],fromList [(4,'d'),(5,'e'),(6,'f')]]
--- 
+--
 -- > splitRoot empty == []
 --
---  Note that the current implementation will not return more than two submaps,
---  but you should not depend on this remaining the case in future versions.
+--  Note that the current implementation does not return more than two submaps,
+--  but you should not depend on this behaviour because it can change in the
+--  future without notice.
 splitRoot :: IntMap a -> [IntMap a]
 splitRoot orig =
   case orig of
index d58583a..dcff687 100644 (file)
@@ -1493,19 +1493,20 @@ foldlStrict f = go
 -- relationships of the output subsets.
 --
 -- Examples:
---     
+--
 -- > splitRoot (fromList [1..120]) == [fromList [1..63],fromList [64..120]]
 -- > splitRoot empty == []
 --
---  Note that the current implementation will not return more than two subsets, but
---  you should not depend on this remaining the case in future versions.  Also, the
---  current version will not continue splitting all the way to individual singleton
---  sets -- it will stop before that.
+--  Note that the current implementation does not return more than two subsets,
+--  but you should not depend on this behaviour because it can change in the
+--  future without notice. Also, the current version does not continue
+--  splitting all the way to individual singleton sets -- it stops at some
+--  point.
 splitRoot :: IntSet -> [IntSet]
 splitRoot orig =
   case orig of
     Nil           -> []
-    -- NOTE: we don't currently split below Tip, but we could.    
+    -- NOTE: we don't currently split below Tip, but we could.
     x@(Tip _ _)   -> [x]
     Bin _ _ l r   -> [l, r]
 {-# INLINE splitRoot #-}
index 8753afa..1f6512f 100644 (file)
@@ -2825,17 +2825,18 @@ foldlStrict f = go
 -- elements in the second, and so on).
 --
 -- Examples:
---     
+--
 -- > splitRoot (fromList (zip [1..6] ['a'..])) ==
 -- >   [fromList [(1,'a'),(2,'b'),(3,'c')],fromList [(4,'d')],fromList [(5,'e'),(6,'f')]]
 --
 -- > splitRoot empty == []
 --
---  Note that the current implementation will not return more than three subsets,
---  but you should not depend on this remaining the case in future versions.
+--  Note that the current implementation does not return more than three submaps,
+--  but you should not depend on this behaviour because it can change in the
+--  future without notice.
 splitRoot :: Map k b -> [Map k b]
 splitRoot orig =
-  case orig of 
+  case orig of
     Tip           -> []
     Bin _ k v l r -> [l, singleton k v, r]
 {-# INLINE splitRoot #-}
index 63c5340..675c966 100644 (file)
@@ -1414,17 +1414,18 @@ foldlStrict f = go
 -- elements in the second, and so on).
 --
 -- Examples:
---     
+--
 -- > splitRoot (fromList [1..6]) ==
 -- >   [fromList [1,2,3],fromList [4],fromList [5,6]]
---    
+--
 -- > splitRoot empty == []
 --
---  Note that the current implementation will not return more than three subsets,
---  but you should not depend on this remaining the case in future versions.
+--  Note that the current implementation does not return more than three subsets,
+--  but you should not depend on this behaviour because it can change in the
+--  future without notice.
 splitRoot :: Set a -> [Set a]
 splitRoot orig =
-  case orig of 
+  case orig of
     Tip           -> []
     Bin _ v l r -> [l, singleton v, r]
 {-# INLINE splitRoot #-}