Fix the doctest

Author: adithyaov

core/src/DocTestDataMutArray.hs

@@ -6,5 +6,6 @@
 
 For APIs that have not been released yet.
 
->>> import Streamly.Internal.Data.MutArray as MutArray
+>>> import qualified Streamly.Internal.Data.Fold as Fold
+>>> import qualified Streamly.Internal.Data.MutArray as MutArray
 -}

core/src/DocTestDataStream.hs

@@ -13,6 +13,7 @@
 >>> import Data.Functor.Identity (runIdentity)
 >>> import Data.IORef
 >>> import Data.Semigroup (cycle1)
+>>> import Data.Word (Word8, Word16)
 >>> import GHC.Exts (Ptr (Ptr))
 >>> import System.IO (stdout, hSetBuffering, BufferMode(LineBuffering))
 
@@ -31,6 +32,9 @@
 
 For APIs that have not been released yet.
 
+>>> import qualified Streamly.Internal.FileSystem.Path as Path
+>>> import qualified Streamly.Internal.Data.Scanr as Scanr
+>>> import qualified Streamly.Internal.Data.Scanl as Scanl
 >>> import qualified Streamly.Internal.Data.Fold as Fold
 >>> import qualified Streamly.Internal.Data.Parser as Parser
 >>> import qualified Streamly.Internal.Data.Stream as Stream

core/src/DocTestDataStreamK.hs

@@ -16,6 +16,7 @@
 
 For APIs that have not been released yet.
 
+>>> import qualified Streamly.Internal.FileSystem.Path as Path
 >>> import qualified Streamly.Internal.Data.StreamK as StreamK
 >>> import qualified Streamly.Internal.FileSystem.DirIO as Dir
 -}

core/src/Streamly/Internal/Data/Array/Type.hs

@@ -447,7 +447,7 @@ fromListRev xs = unsafePerformIO $ unsafeFreeze <$> MA.fromListRev xs
 -- allocated to size N, if the stream terminates before N elements then the
 -- array may hold less than N elements.
 --
--- >>> fromStreamN n = Stream.fold (Array.writeN n)
+-- >>> fromStreamN n = Stream.fold (Array.createOf n)
 --
 -- /Pre-release/
 {-# INLINE_NORMAL fromStreamN #-}
@@ -466,7 +466,7 @@ fromStreamDN = fromStreamN
 -- single array from a stream of unknown size. 'writeN' is at least twice
 -- as efficient when the size is already known.
 --
--- >>> fromStream = Stream.fold Array.write
+-- >>> fromStream = Stream.fold Array.create
 --
 -- Note that if the input stream is too large memory allocation for the array
 -- may fail.  When the stream size is not known, `chunksOf` followed by
@@ -502,7 +502,7 @@ bufferChunks = buildChunks
 --
 -- Same as the following but may be more efficient:
 --
--- >>> chunksOf n = Stream.foldMany (Array.writeN n)
+-- >>> chunksOf n = Stream.foldMany (Array.createOf n)
 --
 -- /Pre-release/
 {-# INLINE_NORMAL chunksOf #-}
@@ -550,7 +550,7 @@ chunksEndByLn' = chunksEndBy' (== fromIntegral (ord '\n'))
 
 -- | Convert a stream of arrays into a stream of their elements.
 --
--- >>> concat = Stream.unfoldMany Array.reader
+-- >>> concat = Stream.unfoldEach Array.reader
 --
 {-# INLINE_NORMAL concat #-}
 concat :: (Monad m, Unbox a) => Stream m (Array a) -> Stream m a
@@ -567,7 +567,7 @@ flattenArrays = concat
 -- | Convert a stream of arrays into a stream of their elements reversing the
 -- contents of each array before flattening.
 --
--- >>> concatRev = Stream.unfoldMany Array.readerRev
+-- >>> concatRev = Stream.unfoldEach Array.readerRev
 --
 {-# INLINE_NORMAL concatRev #-}
 concatRev :: forall m a. (Monad m, Unbox a)
@@ -591,7 +591,7 @@ flattenArraysRev = concatRev
 -- arrays would have no capacity to append, therefore, a copy will be forced
 -- anyway.
 
--- | Fold @createCompactBySizeGE n@ coalesces adjacent arrays in the input
+-- | Fold @createCompactMin n@ coalesces adjacent arrays in the input
 -- stream until the size becomes greater than or equal to n.
 --
 -- Generates unpinned arrays irrespective of the pinning status of input
@@ -618,7 +618,7 @@ fPinnedCompactGE = createCompactMin
 -- | @compactBySize n stream@ coalesces adjacent arrays in the @stream@ until
 -- the size becomes greater than or equal to @n@.
 --
--- >>> compactBySize n = Stream.foldMany (Array.createCompactBySizeGE n)
+-- >>> compactBySize n = Stream.foldMany (Array.createCompactMin n)
 --
 -- Generates unpinned arrays irrespective of the pinning status of input
 -- arrays.
@@ -633,7 +633,7 @@ RENAME(compactGE,compactMin)
 
 -- | Like 'compactBySizeGE' but for transforming folds instead of stream.
 --
--- >>> lCompactBySizeGE n = Fold.many (Array.createCompactBySizeGE n)
+-- >>> lCompactBySizeGE n = Fold.many (Array.createCompactMin n)
 --
 -- Generates unpinned arrays irrespective of the pinning status of input
 -- arrays.
@@ -987,7 +987,7 @@ pinnedWrite = pinnedCreate
 -- could be unsafe and dangerous. This is dangerous especially when used with
 -- foldMany like operations.
 --
--- >>> unsafePureWrite = Array.unsafeMakePure Array.write
+-- >>> unsafePureWrite = Array.unsafeMakePure Array.create
 --
 {-# INLINE unsafeMakePure #-}
 unsafeMakePure :: Monad m => Fold IO a b -> Fold m a b

core/src/Streamly/Internal/Data/Fold/Combinators.hs

@@ -648,7 +648,7 @@ the = foldt' step initial id
 -- identity (@0@) when the stream is empty. Note that this is not numerically
 -- stable for floating point numbers.
 --
--- >>> sum = Fold.cumulative Fold.windowSum
+-- >>> sum = Fold.fromScanl (Scanl.cumulativeScan Scanl.incrSum)
 --
 -- Same as following but numerically stable:
 --
@@ -1936,6 +1936,8 @@ partitionByMUsing t f fld1 fld2 =
 --
 -- Example, send input to the two folds in a proportion of 2:1:
 --
+-- >>> :set -fno-warn-unrecognised-warning-flags
+-- >>> :set -fno-warn-x-partial
 -- >>> :{
 -- proportionately m n = do
 --  ref <- newIORef $ cycle $ concat [replicate m Left, replicate n Right]

core/src/Streamly/Internal/Data/Fold/Window.hs

@@ -88,6 +88,7 @@ import Prelude hiding (length, sum, minimum, maximum)
 -- | Map a function on the incoming as well as outgoing element of a rolling
 -- window fold.
 --
+-- >>> :set -fno-warn-deprecations
 -- >>> lmap f = Fold.lmap (bimap f (f <$>))
 --
 {-# INLINE windowLmap #-}

core/src/Streamly/Internal/Data/MutArray/Type.hs

@@ -2355,9 +2355,6 @@ writeRevN = revCreateOf
 -- | @pinnedWriteNAligned align n@ folds a maximum of @n@ elements from the
 -- input stream to a 'MutArray' aligned to the given size.
 --
--- >>> pinnedWriteNAligned align = MutArray.createWithOf (MutArray.pinnedNewAligned align)
--- >>> pinnedWriteNAligned align n = MutArray.appendN n (MutArray.pinnedNewAligned align n)
---
 -- /Pre-release/
 --
 {-# INLINE_NORMAL pinnedWriteNAligned #-}
@@ -3107,7 +3104,7 @@ cmp = byteCmp
 
 -- | Byte equality of two arrays.
 --
--- >>> byteEq arr1 arr2 = (==) EQ $ MArray.byteCmp arr1 arr2
+-- >>> byteEq arr1 arr2 = (==) EQ <$> MutArray.byteCmp arr1 arr2
 --
 -- /Unsafe/: See 'byteCmp'.
 {-# INLINE byteEq #-}

core/src/Streamly/Internal/Data/Parser/Type.hs

@@ -883,8 +883,8 @@ data AltParseState sl sr = AltParseL !Int !sl | AltParseR !sr
 -- result, if a parser is defined recursively using this, it may cause an
 -- infintie loop. The following example checks the strictness:
 --
--- >>> p = Parser.satisfy (> 0) `Parser.alt` undefined
--- >>> Stream.parse p $ Stream.fromList [1..10]
+-- >> p = Parser.satisfy (> 0) `Parser.alt` undefined
+-- >> Stream.parse p $ Stream.fromList [1..10]
 -- *** Exception: Prelude.undefined
 --
 -- CAVEAT 2: QUADRATIC TIME COMPLEXITY. Static composition is fast due to

core/src/Streamly/Internal/Data/Scanl/Combinators.hs

@@ -1798,6 +1798,8 @@ data PartState sL sR = PartLeft !sL !sR | PartRight !sL !sR
 --
 -- Example, send input to the two folds in a proportion of 2:1:
 --
+-- >>> :set -fno-warn-unrecognised-warning-flags
+-- >>> :set -fno-warn-x-partial
 -- >>> :{
 -- proportionately m n = do
 --  ref <- newIORef $ cycle $ concat [replicate m Left, replicate n Right]

core/src/Streamly/Internal/Data/Scanl/Window.hs

@@ -226,7 +226,7 @@ incrScan n f = incrScanWith n (Scanl.lmap fst f)
 -- | Convert an incremental scan to a cumulative scan using the entire input
 -- stream as a single window.
 --
--- >>> cumulativeScan = Scanl.lmap Insert
+-- >>> cumulativeScan = Scanl.lmap Scanl.Insert
 --
 {-# INLINE cumulativeScan #-}
 cumulativeScan :: Scanl m (Incr a) b -> Scanl m a b