Skip to content

Commit

Permalink
Documentation tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
tibbe committed Nov 21, 2012
1 parent 617f1de commit c2e0c41
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Data/Csv.hs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ import Data.Csv.Types

-- $fieldconversion
--
-- The 'FromField' and 'ToField' define how to convert between
-- The 'FromField' and 'ToField' classes define how to convert between
-- 'Field's and values you care about (e.g. 'Int's). Most of the time
-- you don't need to write your own instances as the standard ones
-- cover most use cases.
8 changes: 3 additions & 5 deletions Data/Csv/Encoding.hs
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,9 @@ parseNamedCsv xs = V.fromList <$!> mapM' parseNamedRecord (V.toList xs)
-- added to 'EncodeOptions', create option records by overriding
-- values in 'defaultEncodeOptions'. Example:
--
-- @
-- myOptions = defaultEncodeOptions {
-- encDelimiter = fromIntegral (ord '\t')
-- }
-- @
-- > myOptions = defaultEncodeOptions {
-- > encDelimiter = fromIntegral (ord '\t')
-- > }
data EncodeOptions = EncodeOptions
{ -- | Field delimiter.
encDelimiter :: {-# UNPACK #-} !Word8
Expand Down
8 changes: 3 additions & 5 deletions Data/Csv/Parser.hs
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,9 @@ import Data.Csv.Util ((<$!>))
-- added to 'DecodeOptions', create option records by overriding
-- values in 'defaultDecodeOptions'. Example:
--
-- @
-- myOptions = defaultDecodeOptions {
-- decDelimiter = fromIntegral (ord '\t')
-- }
-- @
-- > myOptions = defaultDecodeOptions {
-- > decDelimiter = fromIntegral (ord '\t')
-- > }
data DecodeOptions = DecodeOptions
{ -- | Field delimiter.
decDelimiter :: {-# UNPACK #-} !Word8
Expand Down

0 comments on commit c2e0c41

Please sign in to comment.