on master help sign in
Fix documentation typos, add minor clarification
c7b2e4fShlok Datye
src/Streamly/Internal/Data/Stream/Concurrent.hs+3−3
@@ -528,9 +528,9 @@ parApply modifier stream1 stream2 =
528--
528--
529-- >>> parMapM modifier f = Stream.parConcatMap modifier (Stream.fromEffect . f)
529-- >>> parMapM modifier f = Stream.parConcatMap modifier (Stream.fromEffect . f)
530--
530--
531−-- Example, the following example finishes in 1 second as all actions run in
531+-- For example, the following finishes in 3 seconds (as opposed to 6 seconds)
532−-- parallel. Even though results are available out of order they are ordered
532+-- because all actions run in parallel. Even though results are available out
533−-- due to the config option::
533+-- of order they are ordered due to the config option:
534--
534--
535-- >>> f x = delay x >> return x
535-- >>> f x = delay x >> return x
536-- >>> Stream.fold Fold.toList $ Stream.parMapM (Stream.ordered True) f $ Stream.fromList [3,2,1]
536-- >>> Stream.fold Fold.toList $ Stream.parMapM (Stream.ordered True) f $ Stream.fromList [3,2,1]