git.iko.soy/typeable/attoparsec
on master help sign in
Clarify a small doc point
commitfc3c8c70008f68e1cdc8b7fd282c4ce227dda5e8 authorBryan O'Sullivan <bos@serpentine.com> dateThu 29 May 2014, 00:39 (12 years ago) parenta8a14a0
2 files changed+9−7
Data/Attoparsec/ByteString.hs+5−4 Data/Attoparsec/Text.hs+4−3
Data/Attoparsec/ByteString.hs+5−4
@@ -140,10 +140,11 @@ import qualified Data.Attoparsec.Internal.Types as T
140140-- input and could consume more input, it will suspend parsing and
141141-- return a 'T.Partial' continuation.
142142--
143−-- Supplying the 'T.Partial' continuation with another bytestring will
144−-- resume parsing at the point where it was suspended. You must be
145−-- prepared for the result of the resumed parse to be another
146−-- 'T.Partial' continuation.
143+-- Supplying the 'T.Partial' continuation with a bytestring will
144+-- resume parsing at the point where it was suspended, with the
145+-- bytestring you supplied used as new input at the end of the
146+-- existing input. You must be prepared for the result of the resumed
147+-- parse to be another 'T.Partial' continuation.
147148--
148149-- To indicate that you have no more input, supply the 'T.Partial'
149150-- continuation with an empty bytestring.
Data/Attoparsec/Text.hs+4−3
@@ -180,9 +180,10 @@ import qualified Data.Text as T
180180-- return a 'T.Partial' continuation.
181181--
182182-- Supplying the 'T.Partial' continuation with another string will
183−-- resume parsing at the point where it was suspended. You must be
184−-- prepared for the result of the resumed parse to be another
185−-- 'Partial' continuation.
183+-- resume parsing at the point where it was suspended, with the string
184+-- you supplied used as new input at the end of the existing
185+-- input. You must be prepared for the result of the resumed parse to
186+-- be another 'Partial' continuation.
186187--
187188-- To indicate that you have no more input, supply the 'Partial'
188189-- continuation with an 'T.empty' 'Text'.