b9b94b3 · streamly · git.iko.soy

git.iko.soy/streamly

Fix doctests to make them work with cabal-docspec

commitb9b94b32ab116fcff331e98bbfbbb07e412a9c9c authorHarendra Kumar <harendra@composewell.com> dateSun 20 Jun 2021, 23:28 (5 years ago) parente503ca6

16 files changed+38−4

compare with master

unifiedsplit

docs/ConcurrentStreams.hs+1−1

@@ -95,7 +95,7 @@ import Control.Monad.IO.Class (MonadIO(..))

9595import Control.Monad.Trans.Class (MonadTrans (lift))

9696

9797-- CAUTION: please keep setup and imports sections in sync

98−--

98+

9999-- $setup

100100-- >>> :m

101101-- >>> import Data.Function ((&))

docs/Tutorial.hs+1−1

@@ -82,7 +82,7 @@ import Control.Monad.IO.Class (MonadIO(..))

8282import Control.Monad.Trans.Class (MonadTrans (lift))

8383

8484-- CAUTION: please keep setup and imports sections in sync

85−--

85+

8686-- $setup

8787-- >>> :m

8888-- >>> import Data.Function ((&))

src/Streamly/Data/Fold.hs+4

@@ -262,3 +262,7 @@ import Prelude

262262 span, splitAt, break, mapM)

263263

264264import Streamly.Internal.Data.Fold

265+

266+-- $setup

267+-- >>> import qualified Streamly.Data.Fold as Fold

268+-- >>> import qualified Streamly.Prelude as Stream

src/Streamly/Data/Fold/Tee.hs+2−1

@@ -15,7 +15,8 @@

1515-- through the stream twice:

1616--

1717-- >>> import Streamly.Data.Fold.Tee (Tee(..))

18−-- >>> import Streamly.Data.Fold as Fold

18+-- >>> import qualified Streamly.Prelude as Stream

19+-- >>> import qualified Streamly.Data.Fold as Fold

1920--

2021-- >>> avg = (/) <$> (Tee Fold.sum) <*> (Tee $ fmap fromIntegral Fold.length)

2122-- >>> Stream.fold (toFold avg) $ Stream.fromList [1.0..100.0]

src/Streamly/Internal/Data/Array/Foreign/Type.hs+1

@@ -120,6 +120,7 @@ import qualified Data.Foldable as F

120120--

121121-- $setup

122122-- >>> :m

123+-- >>> :set -XMagicHash

123124-- >>> import Prelude hiding (length, foldr, read, unlines, splitAt)

124125-- >>> import Streamly.Internal.Data.Array.Foreign as Array

125126

src/Streamly/Internal/Data/Fold/Type.hs+1

@@ -284,6 +284,7 @@ import Prelude hiding (concatMap, filter, foldr, map, take)

284284

285285-- $setup

286286-- >>> :m

287+-- >>> :set -XFlexibleContexts

287288-- >>> import Prelude hiding (concatMap, filter, map)

288289-- >>> import qualified Streamly.Prelude as Stream

289290-- >>> import qualified Streamly.Data.Fold as Fold

src/Streamly/Internal/Data/Stream/Ahead.hs+1

@@ -64,6 +64,7 @@ import Prelude hiding (map)

6464#include "Instances.hs"

6565

6666-- $setup

67+-- >>> import qualified Streamly.Prelude as Stream

6768-- >>> import Control.Concurrent (threadDelay)

6869-- >>> :{

6970-- delay n = do

src/Streamly/Internal/Data/Stream/Async.hs+2

@@ -72,6 +72,7 @@ import qualified Streamly.Internal.Data.Stream.StreamD.Type as D

7272#include "Instances.hs"

7373

7474-- $setup

75+-- >>> import qualified Streamly.Prelude as Stream

7576-- >>> import Control.Concurrent (threadDelay)

7677-- >>> :{

7778-- delay n = do

@@ -79,6 +80,7 @@ import qualified Streamly.Internal.Data.Stream.StreamD.Type as D

7980-- putStrLn (show n ++ " sec") -- print "n sec"

8081-- return n -- IO Int

8182-- :}

83+--

8284

8385-------------------------------------------------------------------------------

8486-- Async

src/Streamly/Internal/Data/Stream/IsStream/Enumeration.hs+4−1

@@ -66,6 +66,10 @@ import Streamly.Internal.Data.Stream.StreamK.Type (IsStream(..))

6666import qualified Streamly.Internal.Data.Stream.StreamD.Generate as D

6767import qualified Streamly.Internal.Data.Stream.Serial as Serial (map)

6868

69+-- $setup

70+-- >>> import Streamly.Prelude as Stream

71+-- >>> import Streamly.Internal.Data.Stream.IsStream.Enumeration as Stream

72+

6973-------------------------------------------------------------------------------

7074-- Enumeration of Integral types

7175-------------------------------------------------------------------------------

@@ -78,7 +82,6 @@ import qualified Streamly.Internal.Data.Stream.Serial as Serial (map)

7882-- check for overflow, underflow or bounds.

7983--

8084-- @

81−-- >>> import Streamly.Internal.Data.Stream.IsStream.Enumeration as Stream

8285-- >>> Stream.toList $ Stream.take 4 $ Stream.enumerateFromStepIntegral 0 2

8386-- [0,2,4,6]

8487--

src/Streamly/Internal/Data/Stream/Parallel.hs+1

@@ -84,6 +84,7 @@ import qualified Streamly.Internal.Data.Stream.SVar as SVar

8484

8585--

8686-- $setup

87+-- >>> import qualified Streamly.Prelude as Stream

8788-- >>> import Control.Concurrent (threadDelay)

8889-- >>> :{

8990-- delay n = do

src/Streamly/Internal/Data/Stream/Serial.hs+3

@@ -83,6 +83,9 @@ import Prelude hiding (map, mapM, errorWithoutStackTrace)

8383#include "Instances.hs"

8484#include "inline.hs"

8585

86+-- $setup

87+-- >>> import qualified Streamly.Prelude as Stream

88+

8689------------------------------------------------------------------------------

8790-- SerialT

8891------------------------------------------------------------------------------

src/Streamly/Internal/Data/Stream/StreamK/Type.hs+3

@@ -89,6 +89,9 @@ import Prelude hiding (map, mapM, concatMap, foldr)

8989

9090import Streamly.Internal.Data.SVar

9191

92+-- $setup

93+-- >>> import Streamly.Prelude as Stream

94+

9295------------------------------------------------------------------------------

9396-- Basic stream type

9497------------------------------------------------------------------------------

src/Streamly/Internal/Data/Stream/Zip.hs+1

@@ -71,6 +71,7 @@ import Prelude hiding (map, repeat, zipWith, errorWithoutStackTrace)

7171#include "Instances.hs"

7272

7373-- $setup

74+-- >>> import qualified Streamly.Prelude as Stream

7475-- >>> import Control.Concurrent (threadDelay)

7576-- >>> :{

7677-- delay n = do

src/Streamly/Internal/Data/Unfold.hs+4

@@ -256,6 +256,10 @@ import Prelude

256256 hiding (map, mapM, takeWhile, take, filter, const, zipWith

257257 , drop, dropWhile)

258258

259+-- $setup

260+-- >>> import qualified Streamly.Data.Fold as Fold

261+-- >>> import qualified Streamly.Internal.Data.Unfold as Unfold

262+

259263-------------------------------------------------------------------------------

260264-- Input operations

261265-------------------------------------------------------------------------------

src/Streamly/Internal/Data/Unfold/Type.hs+5

@@ -63,6 +63,11 @@ import Streamly.Internal.Data.Stream.StreamD.Step (Step(..))

6363

6464import Prelude hiding (const, map, concatMap, zipWith)

6565

66+-- $setup

67+-- >>> import qualified Streamly.Prelude as Stream

68+-- >>> import qualified Streamly.Data.Fold as Fold

69+-- >>> import qualified Streamly.Internal.Data.Unfold as Unfold

70+

6671------------------------------------------------------------------------------

6772-- Monadic Unfolds

6873------------------------------------------------------------------------------

src/Streamly/Prelude.hs+4

@@ -945,6 +945,10 @@ import Prelude

945945

946946import Streamly.Internal.Data.Stream.IsStream

947947

948+-- $setup

949+-- >>> import qualified Streamly.Data.Fold as Fold

950+-- >>> import qualified Streamly.Prelude as Stream

951+

948952-- $serial

949953--

950954-- Serial streams are /spatially ordered/, they execute the actions in the