Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning to demux documentation #2402

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add warning to demux documentation #2402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/src/Streamly/Internal/Data/Fold/Container.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,10 @@ demuxGeneric getKey getFold = fmap extract $ foldlM' step initial
-- This can be used to scan a stream and collect the results from the scan
-- output.
--
-- /Warning/: One should call the returned monadic action to make sure the
-- folds fully complete—even if the action returns nothing useful (e.g., a map
-- of @()@ values).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be the case unless there is some laziness somewhere. Can you test and confirm that this makes a difference?

--
-- /Pre-release/
--
{-# INLINE demux #-}
Expand Down