[commit: packages/containers] ghc-head: Documentation improvements, whitespace cleaning. (9f98bbf)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/containers

On branch  : ghc-head
Link       : http://git.haskell.org/packages/containers.git/commitdiff/9f98bbf5575103d6046d7f40cff7864a51b0834c

>---------------------------------------------------------------

commit 9f98bbf5575103d6046d7f40cff7864a51b0834c
Author: Milan Straka <fox at ucw.cz>
Date:   Wed Dec 4 19:30:45 2013 +0100

    Documentation improvements, whitespace cleaning.


>---------------------------------------------------------------

9f98bbf5575103d6046d7f40cff7864a51b0834c
 Data/IntMap/Base.hs |    5 +++--
 Data/IntSet/Base.hs |    9 +++++----
 Data/Map/Base.hs    |    5 +++--
 Data/Set/Base.hs    |    5 +++--
 4 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/Data/IntMap/Base.hs b/Data/IntMap/Base.hs
index 08448dd..ebdbc12 100644
--- a/Data/IntMap/Base.hs
+++ b/Data/IntMap/Base.hs
@@ -2092,8 +2092,9 @@ foldlStrict f = go
 --
 -- > 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
diff --git a/Data/IntSet/Base.hs b/Data/IntSet/Base.hs
index d58583a..dcff687 100644
--- a/Data/IntSet/Base.hs
+++ b/Data/IntSet/Base.hs
@@ -1497,10 +1497,11 @@ foldlStrict f = go
 -- > 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
diff --git a/Data/Map/Base.hs b/Data/Map/Base.hs
index 8753afa..1f6512f 100644
--- a/Data/Map/Base.hs
+++ b/Data/Map/Base.hs
@@ -2831,8 +2831,9 @@ foldlStrict f = go
 --
 -- > 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
diff --git a/Data/Set/Base.hs b/Data/Set/Base.hs
index 63c5340..675c966 100644
--- a/Data/Set/Base.hs
+++ b/Data/Set/Base.hs
@@ -1420,8 +1420,9 @@ foldlStrict f = go
 --
 -- > 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