network-attoparsec 0.9.1 → 0.9.2

raw patch · 2 files changed

+16/−10 lines, 2 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• network-attoparsec.cabal +2/−3
• src/Network/Attoparsec.hs +14/−7

@@ -1,10 +1,9 @@ name: network-attoparsec
 category: Network, Parsing
-version: 0.9.1
-description: Run an attoparsec parser against a TCP socket
+version: 0.9.2
 license: MIT
 license-file: LICENSE
-copyright: (c) 2014 Leon Mergen
+copyright: (c) 2015 Leon Mergen
 author: Leon Mergen
 maintainer: leon@solatis.com
 homepage: http://github.com/solatis/haskell-network-attoparsec

@@ -1,11 +1,20 @@ {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE OverloadedStrings #-}
 
--- | Utility functions for running a parser against a socket, without the need
---   of a bigger framework such as Pipes or Conduit.
+{-|
+Module      : network-attoparsec
+Description : Utility functions for running a parser against a socket
+Copyright   : (c) Leon Mergen, 2015
+License     : MIT
+Maintainer  : leon@solatis.com
+Stability   : experimental
 
-module Network.Attoparsec (parseMany, parseOne) where
+Utility functions for running a parser against a socket, without the need of a
+bigger framework such as Pipes or Conduit.
+-}
 
+module Network.Attoparsec (ParseC, parseMany, parseOne) where
+
 import           Control.Monad.Error
 
 import qualified Data.ByteString            as BS
@@ -16,9 +25,7 @@ -- | The parsing continuation form of a "Data.Attoparsec" parser. This is
 --   typically created by running the attoparsec "parse" function:
 --
---   @
---     createParser = AttoParsec.parse myParser
---   @
+--   > createParser = AttoParsec.parse myParser
 type ParseC a = BS.ByteString -> Atto.Result a
 
 -- | The type of parsing to perform, greedy or non-greedy
@@ -33,7 +40,7 @@ --
 --   > doParse sock = do
 --   >   (p1, xs1) <- parseMany sock (AttoParsec.parse myParser) (AttoParsec.parse myParser)
---   >   (_,  xs2) <- parseMany sock (AttoParsec.parse myPArser) p1
+--   >   (_,  xs2) <- parseMany sock (AttoParsec.parse myParser) p1
 --   >   return (xs1 ++ xs2)
 --
 --   For more usage examples, see the test directory.