add doc pointers to Foldable
authorRoss Paterson <ross@soi.city.ac.uk>
Fri, 2 Feb 2007 11:09:31 +0000 (11:09 +0000)
committerRoss Paterson <ross@soi.city.ac.uk>
Fri, 2 Feb 2007 11:09:31 +0000 (11:09 +0000)
Could be applied to STABLE.

Data/Sequence.hs

index 402dcfe..318dc20 100644 (file)
@@ -41,6 +41,9 @@ module Data.Sequence (
        (><),           -- :: Seq a -> Seq a -> Seq a
        fromList,       -- :: [a] -> Seq a
        -- * Deconstruction
+       -- | Additional functions for deconstructing sequences are available
+       -- via the 'Foldable' instance of 'Seq'.
+
        -- ** Queries
        null,           -- :: Seq a -> Bool
        length,         -- :: Seq a -> Int
@@ -1008,6 +1011,8 @@ splitDigit i (Four a b c d)
 ------------------------------------------------------------------------
 
 -- | /O(n)/. Create a sequence from a finite list of elements.
+-- There is a function 'toList' in the opposite direction for all
+-- instances of the 'Foldable' class, including 'Seq'.
 fromList       :: [a] -> Seq a
 fromList       =  Data.List.foldl' (|>) empty