Permalink
Browse files

More documentation improvements

  • Loading branch information...
1 parent 51a5d9c commit b36da3724945a9c5ade3e2a8ad243d56e9958bc4 @tibbe tibbe committed Nov 30, 2012
Showing with 6 additions and 6 deletions.
  1. +2 −1 Data/Csv/Incremental.hs
  2. +1 −1 Data/Csv/Parser.hs
  3. +3 −4 Data/Csv/Streaming.hs
@@ -124,7 +124,8 @@ feedEndOfInputH (PartialH k) = k B.empty
feedEndOfInputH p = p
-- | Parse a CSV header in an incremental fashion. When done, the
--- 'HeaderParser' returns any unconsumed input in its second field.
+-- 'HeaderParser' returns any unconsumed input in the second field of
+-- the 'DoneH' constructor.
decodeHeader :: HeaderParser B.ByteString
decodeHeader = decodeHeaderWith defaultDecodeOptions
View
@@ -6,7 +6,7 @@
-- * Empty lines are ignored.
--
-- * Non-escaped fields may contain any characters except
--- double-quotes, commas, carriage returns, and newlines
+-- double-quotes, commas, carriage returns, and newlines.
--
-- * Escaped fields may contain any characters (but double-quotes
-- need to be escaped).
@@ -46,17 +46,16 @@ import Data.Csv.Types
--
-- A short usage example:
--
--- @ for_ ('decode' False \"John,27\\r\\nJane,28\\r\\n\") $ \\ (name, age :: Int) ->
--- putStrLn $ name ++ \" is \" ++ show age ++ \" years old\"
--- @
+-- > for_ (decode False "John,27\r\nJane,28\r\n") $ \ (name, age :: Int) ->
+-- > putStrLn $ name ++ " is " ++ show age ++ " years old"
--
-- N.B. The 'Foldable' instance, which is used above, skips records
-- that failed to convert. If you don't want this behavior, work
-- directly with the 'Cons' and 'Nil' constructors.
-- $stream-representation
--
--- A stream of records is represented like a (lazy) list that may
+-- A stream of records is represented as a (lazy) list that may
-- contain errors.
-- $typeconversion

0 comments on commit b36da37

Please sign in to comment.