on master help sign in
Fix documentation in the Stream Prelude module
81bdc75Harendra Kumar
core/src/Streamly/Internal/Data/Stream/Expand.hs+2
@@ -200,6 +200,8 @@ append = (<>)
200-- Interleaving
200-- Interleaving
201------------------------------------------------------------------------------
201------------------------------------------------------------------------------
202
202
203+infixr 6 `interleave`
204+
203-- | Interleaves two streams, yielding one element from each stream
205-- | Interleaves two streams, yielding one element from each stream
204-- alternately. When one stream stops the rest of the other stream is used in
206-- alternately. When one stream stops the rest of the other stream is used in
205-- the output stream.
207-- the output stream.
core/src/Streamly/Internal/Data/Stream/Zip.hs+1−1
@@ -47,7 +47,7 @@ import qualified Streamly.Internal.Data.Stream.Generate as Stream
47--
47--
48-- @
48-- @
49-- (<>) = 'Streamly.Data.Stream.append'
49-- (<>) = 'Streamly.Data.Stream.append'
50−-- (<*>) = 'Streamly.Data.Stream.zipWith' id
50+-- (\<*>) = 'Streamly.Data.Stream.zipWith' id
51-- @
51-- @
52--
52--
53-- Applicative evaluates the streams being zipped serially:
53-- Applicative evaluates the streams being zipped serially:
src/Streamly/Data/Stream/Prelude.hs+6
@@ -10,6 +10,12 @@
10-- "streamly-core" package and additionally provides concurrency, time and
10-- "streamly-core" package and additionally provides concurrency, time and
11-- lifted exception operations as well in a single module.
11-- lifted exception operations as well in a single module.
12--
12--
13+-- Also see the following modules for more pre-release operations:
14+--
15+-- * "Streamly.Internal.Data.Stream.Concurrent"
16+-- * "Streamly.Internal.Data.Stream.Time"
17+-- * "Streamly.Internal.Data.Stream.Exception.Lifted"
18+--
13module Streamly.Data.Stream.Prelude
19module Streamly.Data.Stream.Prelude
14 ( module Streamly.Data.Stream
20 ( module Streamly.Data.Stream
15 , module Streamly.Data.Stream.Concurrent
21 , module Streamly.Data.Stream.Concurrent