diff --git a/bluefin/src/Bluefin/Stream.hs b/bluefin/src/Bluefin/Stream.hs index eeb2004..efc48bb 100644 --- a/bluefin/src/Bluefin/Stream.hs +++ b/bluefin/src/Bluefin/Stream.hs @@ -1,5 +1,12 @@ module Bluefin.Stream - ( -- * Handle + ( -- | 'Stream' allows you to yield values during the execution of a + -- Bluefin operation. It provides similar functionality to + -- Python's @yield@. The handler of the 'Stream' will either + -- handle each element as soon as it is yielded (for example + -- 'forEach') or gather all yielded elements int o a list (for + -- example 'yieldToList'). + + -- * Handle Stream, -- * Handlers forEach,