Skip to content

Commit e685751

Browse files
authored
Haddock on Parser
To explain that it might not be what users typically think of as a "parser"
1 parent b816c73 commit e685751

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Data/Aeson/Types/Internal.hs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,9 @@ type Failure f r = JSONPath -> String -> f r
270270
-- | Success continuation.
271271
type Success a f r = a -> f r
272272

273-
-- | A JSON parser.
273+
-- | A JSON parser. N.B. This might not fit your usual understanding of
274+
-- "parser". Instead you might like to think of 'Parser' as a "parse result",
275+
-- i.e. a parser to which the input has already been applied.
274276
newtype Parser a = Parser {
275277
runParser :: forall f r.
276278
JSONPath

0 commit comments

Comments
 (0)