on master help sign in
Minor doc edits
ffa84b1Harendra Kumar
src/Asyncly/Prelude.hs+8−8
@@ -69,17 +69,17 @@ import Asyncly.AsyncT
69
69
70-- $product
70-- $product
71--
71--
72−-- Different styles of streams dictate the manner in which a stream is
72+-- Different styles of streams represented by different types dictate the
73−-- processed in monadic or applicative composition. Each style is represented
73+-- manner in which a stream is processed in monadic or applicative composition.
74+-- Each type differs in the processing order of the elements or processing
74−-- by a different type. The types have the same underlying representation and
75+-- parallelism. The types have the same underlying representation and
75-- therefore can be converted back and forth easily to switch the composition
76-- therefore can be converted back and forth easily to switch the composition
76−-- style at any point. In other words, processing order of the elements or
77+-- style at any point.
77−-- processing parallelism is decided by the type of the stream.
78--
78--
79-- 'StreamT' and 'InterleavedT' process the streams serially but differ in the
79-- 'StreamT' and 'InterleavedT' process the streams serially but differ in the
80-- order in which the elements of the streams are processed. 'StreamT' goes
80-- order in which the elements of the streams are processed. 'StreamT' goes
81-- depth first that is it combine one element of the first stream to every
81-- depth first that is it combine one element of the first stream to every
82−-- element of the second stream before it comes back to process th second
82+-- element of the second stream before it comes back to process the second
83-- element of the first stream. 'InterleavedT' takes turns when processing
83-- element of the first stream. 'InterleavedT' takes turns when processing
84-- elements from each stream and therefore all iterations finish at the same
84-- elements from each stream and therefore all iterations finish at the same
85-- time rather than one iteration at a time as in the case of 'StreamT'.
85-- time rather than one iteration at a time as in the case of 'StreamT'.
@@ -88,8 +88,8 @@ import Asyncly.AsyncT
88--
88--
89-- 'AsyncT' and 'ParallelT' can process the individual elements of the streams
89-- 'AsyncT' and 'ParallelT' can process the individual elements of the streams
90-- in parallel. 'AsyncT' is the parallel version of 'StreamT', it follows the
90-- in parallel. 'AsyncT' is the parallel version of 'StreamT', it follows the
91−-- order of 'StreamT' processing multiple elements of a stream concurrently.
91+-- order of 'StreamT', processing multiple elements of a stream concurrently.
92−-- 'ParallelT' follows the order of 'InterleavedT' processing and interleaving
92+-- 'ParallelT' follows the order of 'InterleavedT', processing and interleaving
93-- both streams concurrently. Also, note that 'fmap' on these streams would
93-- both streams concurrently. Also, note that 'fmap' on these streams would
94-- also work in a concurrent fashion i.e. multiple elements in a stream or
94-- also work in a concurrent fashion i.e. multiple elements in a stream or
95-- multiple streams can be mapped concurrently.
95-- multiple streams can be mapped concurrently.