@@ -119,9 +119,10 @@ module Streamly.Internal.Data.Parser.ParserD
119119 , takeWhile1
120120 , dropWhile
121121
122− -- ** Single Element Separators
122+ -- ** Separated by elements
123123 -- | Separator could be in prefix postion ('takeStartBy'), or suffix
124− -- position ('takeEndBy').
124+ -- position ('takeEndBy'). See 'deintercalate', 'sepBy' etc for infix
125+ -- separator parsing, also see 'intersperseQuotedBy' fold.
125126
126127 -- These can be implemented modularly with refolds, using takeWhile and
127128 -- satisfy.
@@ -134,19 +135,24 @@ module Streamly.Internal.Data.Parser.ParserD
134135 , takeEitherSepBy
135136 , wordBy
136137
137− -- ** By comparing
138+ -- ** Grouped by element comparison
138139 , groupBy
139140 , groupByRolling
140141 , groupByRollingEither
141142
142− -- ** Framing
143+ -- ** Framed by elements
144+ -- | Also see 'intersperseQuotedBy' fold.
145+ -- Framed by a one or more ocurrences of a separator around a word like
146+ -- spaces or quotes. No nesting.
147+ , wordFramedBy -- XXX Remove this? Covered by wordWithQuotes?
148+ , wordWithQuotes
149+ , wordStripQuotes
150+
151+ -- Framed by separate start and end characters, potentially nested.
143152 -- , takeFramedBy
144153 , takeFramedBy_
145154 , takeFramedByEsc_
146155 , takeFramedByGeneric
147− , wordFramedBy
148− , wordWithQuotes
149− , wordStripQuotes
150156 , blockWithQuotes
151157
152158 -- Matching strings
@@ -1029,9 +1035,9 @@ data FramedEscState s =
10291035-- XXX We can remove Maybe from esc
10301036{-# INLINE takeFramedByGeneric #-}
10311037takeFramedByGeneric :: Monad m =>
1032− Maybe (a -> Bool)
1033− -> Maybe (a -> Bool)
1034− -> Maybe (a -> Bool)
1038+ Maybe (a -> Bool) -- is escape char?
1039+ -> Maybe (a -> Bool) -- is frame begin?
1040+ -> Maybe (a -> Bool) -- is frame end?
10351041 -> Fold m a b
10361042 -> Parser a m b
10371043takeFramedByGeneric esc begin end (Fold fstep finitial fextract) =