on master help sign in
Add "See also" for pre-release modules
043f134Harendra Kumar
src/Streamly/Prelude.hs+19−1
@@ -320,7 +320,10 @@
320module Streamly.Prelude
320module Streamly.Prelude
321 (
321 (
322 -- * Construction
322 -- * Construction
323− -- | Functions ending in the general shape @b -> t m a@
323+ -- | Functions ending in the general shape @b -> t m a@.
324+ --
325+ -- See also: "Streamly.Internal.Data.Stream.IsStream.Generate" for
326+ -- @Pre-release@ functions.
324
327
325 -- ** Primitives
328 -- ** Primitives
326 -- | Primitives to construct a stream from pure values or monadic actions.
329 -- | Primitives to construct a stream from pure values or monadic actions.
@@ -389,6 +392,9 @@ module Streamly.Prelude
389
392
390 -- * Elimination
393 -- * Elimination
391 -- | Functions ending in the general shape @t m a -> m b@
394 -- | Functions ending in the general shape @t m a -> m b@
395+ --
396+ -- See also: "Streamly.Internal.Data.Stream.IsStream.Eliminate" for
397+ -- @Pre-release@ functions.
392
398
393 -- ** Running a 'Fold'
399 -- ** Running a 'Fold'
394 -- $runningfolds
400 -- $runningfolds
@@ -549,6 +555,8 @@ module Streamly.Prelude
549 , stripPrefix
555 , stripPrefix
550
556
551 -- * Transformation
557 -- * Transformation
558+ -- | See also: "Streamly.Internal.Data.Stream.IsStream.Transform" for
559+ -- @Pre-release@ functions.
552
560
553 -- ** Mapping
561 -- ** Mapping
554 -- | In imperative terms a map operation can be considered as a loop over
562 -- | In imperative terms a map operation can be considered as a loop over
@@ -714,6 +722,9 @@ module Streamly.Prelude
714 --
722 --
715 -- See 'maxThreads' and 'maxBuffer' to control the concurrency of the
723 -- See 'maxThreads' and 'maxBuffer' to control the concurrency of the
716 -- concurrent combinators.
724 -- concurrent combinators.
725+ --
726+ -- See also: "Streamly.Internal.Data.Stream.IsStream.Expand" for
727+ -- @Pre-release@ functions.
717
728
718 -- ** Linear combinators
729 -- ** Linear combinators
719 -- | These functions have O(n) append performance. They can be used
730 -- | These functions have O(n) append performance. They can be used
@@ -785,6 +796,10 @@ module Streamly.Prelude
785 , concatForFoldableWith
796 , concatForFoldableWith
786
797
787 -- * Reducing
798 -- * Reducing
799+ -- |
800+ -- See also: "Streamly.Internal.Data.Stream.IsStream.Reduce" for
801+ -- @Pre-release@ functions.
802+
788 -- ** Nested Folds
803 -- ** Nested Folds
789 , foldMany
804 , foldMany
790 , chunksOf
805 , chunksOf
@@ -832,6 +847,9 @@ module Streamly.Prelude
832 -- For example, instead of calling them on a stream of chars call them on a
847 -- For example, instead of calling them on a stream of chars call them on a
833 -- stream of arrays before flattening it to a stream of chars.
848 -- stream of arrays before flattening it to a stream of chars.
834 --
849 --
850+ -- See also: "Streamly.Internal.Data.Stream.IsStream.Exception" for
851+ -- @Pre-release@ functions.
852+
835 , before
853 , before
836 , after
854 , after
837 , bracket
855 , bracket