Commits

Bryan O'Sullivan committed f55a52d

Clarify a small doc point

  • Participants
  • Parent commits 11fab58

Comments (0)

Files changed (2)

Data/Attoparsec/ByteString.hs

 -- input and could consume more input, it will suspend parsing and
 -- return a 'T.Partial' continuation.
 --
--- Supplying the 'T.Partial' continuation with another bytestring will
--- resume parsing at the point where it was suspended. You must be
--- prepared for the result of the resumed parse to be another
--- 'T.Partial' continuation.
+-- Supplying the 'T.Partial' continuation with a bytestring will
+-- resume parsing at the point where it was suspended, with the
+-- bytestring you supplied used as new input at the end of the
+-- existing input. You must be prepared for the result of the resumed
+-- parse to be another 'T.Partial' continuation.
 --
 -- To indicate that you have no more input, supply the 'T.Partial'
 -- continuation with an empty bytestring.

Data/Attoparsec/Text.hs

 -- return a 'T.Partial' continuation.
 --
 -- Supplying the 'T.Partial' continuation with another string will
--- resume parsing at the point where it was suspended. You must be
--- prepared for the result of the resumed parse to be another
--- 'Partial' continuation.
+-- resume parsing at the point where it was suspended, with the string
+-- you supplied used as new input at the end of the existing
+-- input. You must be prepared for the result of the resumed parse to
+-- be another 'Partial' continuation.
 --
 -- To indicate that you have no more input, supply the 'Partial'
 -- continuation with an 'T.empty' 'Text'.