Fix documentation in the Stream Prelude module
Fix docs of zipWith and interleave
Fix module documentation
commit81bdc75a9c2b20270de2329a04865ba8aab92142
authorHarendra Kumar <harendra@composewell.com>
dateMon 26 Dec 2022, 09:33 (4 years ago)
parent03bfd3f
core/src/Streamly/Internal/Data/Stream/Expand.hs+2
@@ -200,6 +200,8 @@ append = (<>)
200200-- Interleaving
201201------------------------------------------------------------------------------
202202
203+infixr 6 `interleave`
204+
203205-- | Interleaves two streams, yielding one element from each stream
204206-- alternately. When one stream stops the rest of the other stream is used in
205207-- 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
4747--
4848-- @
4949-- (<>) = 'Streamly.Data.Stream.append'
50−-- (<*>) = 'Streamly.Data.Stream.zipWith' id
50+-- (\<*>) = 'Streamly.Data.Stream.zipWith' id
5151-- @
5252--
5353-- Applicative evaluates the streams being zipped serially:
src/Streamly/Data/Stream/Prelude.hs+6
@@ -10,6 +10,12 @@
1010-- "streamly-core" package and additionally provides concurrency, time and
1111-- lifted exception operations as well in a single module.
1212--
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+--
1319module Streamly.Data.Stream.Prelude
1420 ( module Streamly.Data.Stream
1521 , module Streamly.Data.Stream.Concurrent