@@ -3682,12 +3682,14 @@ splitSuffixOnAny subseq f m = undefined
3682-- Nested Split
3682-- Nested Split
3683------------------------------------------------------------------------------
3683------------------------------------------------------------------------------
3685−-- | Consider a chunked stream of container elements e.g. a stream of @Word8@
3686−-- chunked as a stream of arrays of @Word8@. @splitInnerBy splitter joiner
3687−-- stream@ splits the inner containers @f a@ using the @splitter@ function and
3685+-- | @splitInnerBy splitter joiner stream@ splits the inner containers @f a@ of
3688−-- joins back the resulting fragments from splitting across multiple containers
3686+-- an input stream @t m (f a)@ using the @splitter@ function. Container
3687+-- elements @f a@ are collected until a split occurs, then all the elements
3689−-- using the @joiner@ function such that the transformed output stream is
3688+-- before the split are joined using the @joiner@ function.
3690−-- consolidated as one container per segment of the split.
3689+--
3690+-- For example, if we have a stream of @Array Word8@, we may want to split the
3691+-- stream into arrays representing lines separated by '\n' byte such that the
3692+-- resulting stream after a split would be one array for each line.
3692-- CAUTION! This is not a true streaming function as the container size after
3694-- CAUTION! This is not a true streaming function as the container size after
3693-- the split and merge may not be bounded.
3695-- the split and merge may not be bounded.