on master help sign in
Clarify documentation about ParserD's 'extract'
commit13e3129e1215b011322d2f8454f3f610ac901af1 authorJulian Ospald <hasufell@posteo.de> dateSun 24 Oct 2021, 18:11 (5 years ago) parent9119e44
1 file changed+2−1
src/Streamly/Internal/Data/Parser/ParserD/Type.hs+2−1
src/Streamly/Internal/Data/Parser/ParserD/Type.hs+2−1
@@ -315,7 +315,8 @@ mapMStep f res =
315315-- results into a new state and a command to the driver represented by 'Step'
316316-- type. The driver keeps invoking the step function until it stops or fails.
317317-- At any point of time the driver can call @extract@ to inspect the result of
318−-- the fold. It may result in an error or an output value.
318+-- the fold. If the parser hits the end of input 'extract' is called.
319+-- It may result in an error or an output value.
319320--
320321-- /Pre-release/
321322--