git.iko.soy/typeable/attoparsec
on master help sign in
Clarify documentation for lazy bytestring and text parsers

This fixes gh-52.

commit4f10f29ddc81632532651157e2aeb613679f8a5e authorBryan O'Sullivan <bos@serpentine.com> dateWed 8 Jan 2014, 16:21 (13 years ago) parentc96ba2a
2 files changed+13−11
compare with master
unifiedsplit
Data/Attoparsec/ByteString/Lazy.hs+7−6 Data/Attoparsec/Text/Lazy.hs+6−5
Data/Attoparsec/ByteString/Lazy.hs+7−6
@@ -7,8 +7,8 @@
77-- Stability : experimental
88-- Portability : unknown
99--
10−-- Simple, efficient combinator parsing for lazy 'ByteString'
11−-- strings, loosely based on the Parsec library.
10+-- Simple, efficient combinator parsing that can consume lazy
11+-- 'ByteString' strings, loosely based on the Parsec library.
1212--
1313-- This is essentially the same code as in the 'Data.Attoparsec'
1414-- module, only with a 'parse' function that can consume a lazy
@@ -16,10 +16,11 @@
1616-- more input to be fed in. Think of this as suitable for use with a
1717-- lazily read file, e.g. via 'L.readFile' or 'L.hGetContents'.
1818--
19−-- Behind the scenes, strict 'B.ByteString' values are still used
20−-- internally to store parser input and manipulate it efficiently.
21−-- High-performance parsers such as 'string' still expect strict
22−-- 'B.ByteString' parameters.
19+-- /Note:/ The various parser functions and combinators such as
20+-- 'string' still expect /strict/ 'B.ByteString' parameters, and
21+-- return strict 'B.ByteString' results. Behind the scenes, strict
22+-- 'B.ByteString' values are still used internally to store parser
23+-- input and manipulate it efficiently.
2324
2425module Data.Attoparsec.ByteString.Lazy
2526 (
Data/Attoparsec/Text/Lazy.hs+6−5
@@ -7,7 +7,7 @@
77-- Stability : experimental
88-- Portability : unknown
99--
10−-- Simple, efficient combinator parsing for lazy 'Text'
10+-- Simple, efficient combinator parsing that can consume lazy 'Text'
1111-- strings, loosely based on the Parsec library.
1212--
1313-- This is essentially the same code as in the 'Data.Attoparsec.Text'
@@ -16,10 +16,11 @@
1616-- more input to be fed in. Think of this as suitable for use with a
1717-- lazily read file, e.g. via 'L.readFile' or 'L.hGetContents'.
1818--
19−-- Behind the scenes, strict 'T.Text' values are still used
20−-- internally to store parser input and manipulate it efficiently.
21−-- High-performance parsers such as 'string' still expect strict
22−-- 'T.Text' parameters.
19+-- /Note:/ The various parser functions and combinators such as
20+-- 'string' still expect /strict/ 'T.Text' parameters, and return
21+-- strict 'T.Text' results. Behind the scenes, strict 'T.Text' values
22+-- are still used internally to store parser input and manipulate it
23+-- efficiently.
2324
2425module Data.Attoparsec.Text.Lazy
2526 (