on master help sign in
Update doc of "eager" for clarity
d24441bHarendra Kumar
src/Streamly/Internal/Data/Channel/Types.hs+4−4
@@ -495,10 +495,10 @@ getInspectMode = _inspect
495
495
496-- | By default, processing of output from the worker threads is given priority
496-- | By default, processing of output from the worker threads is given priority
497-- over dispatching new workers. More workers are dispatched only when there is
497-- over dispatching new workers. More workers are dispatched only when there is
498−-- no output to process. With 'eager' on workers are dispatched aggresively as
498+-- no output to process. When 'eager' is set to 'True', workers are dispatched
499−-- long as there is more work to do irrespective of whether there is output
499+-- aggresively as long as there is more work to do irrespective of whether
500+-- there is output pending to be processed by the stream consumer. However,
500−-- pending to be processed. However, dispatching may stop if 'maxThreads' or
501+-- dispatching may stop if 'maxThreads' or 'maxBuffer' is reached.
501−-- 'maxBuffer' is reached.
502--
502--
503-- /Note:/ This option has no effect when rate has been specified.
503-- /Note:/ This option has no effect when rate has been specified.
504--
504--