on master help sign in
Update comments in export list of Concurrent
b7e8907Harendra Kumar
src/Streamly/Internal/Data/Stream/Concurrent.hs+15−2
@@ -42,17 +42,25 @@ module Streamly.Internal.Data.Stream.Concurrent
42 , inspectMode
42 , inspectMode
43
43
44 -- * Combinators
44 -- * Combinators
45− -- | Stream combinators using Async channel
45+ -- | Stream combinators using a concurrent channel
46
46
47+ -- ** Evaluate
48+ -- | Evaluate a stream concurrently using a channel.
47 , eval
49 , eval
48 , evalWith
50 , evalWith
51+ -- Add unfoldrM/iterateM?
49
52
53+ -- ** Map
54+ -- | Use a single channel to evaluate all actions.
50 , mapM
55 , mapM
51 , mapMWith
56 , mapMWith
52 , sequence
57 , sequence
53 , sequenceWith
58 , sequenceWith
59+ -- Add repeatM/replicateM?
54
60
55− -- XXX experimental binary ops, move to parallel?
61+ -- ** Combine two
62+ -- | Use a channel for each pair.
63+ -- combine/concur/conjoin
56 , append
64 , append
57 , appendWith
65 , appendWith
58 , interleave
66 , interleave
@@ -62,8 +70,13 @@ module Streamly.Internal.Data.Stream.Concurrent
62 , parallelFst
70 , parallelFst
63 , parallelMin
71 , parallelMin
64
72
73+ -- ** Apply
74+ -- | Use a separate channel for each application.
65 , apply
75 , apply
66 , applyWith
76 , applyWith
77+
78+ -- ** Combine many
79+ -- | Share a single channel across many streams.
67 , concatList
80 , concatList
68 , concat
81 , concat
69 , concatWith
82 , concatWith