Skip to content

Commit

Permalink
Small doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mightybyte committed Aug 24, 2012
1 parent f559134 commit d97b39c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Readable
========

The Read type class is very useful for building data types from String
representations. But String has high overhead, so sometimes it isn't
suitable for applications where space usage and performance are important.
This library provides similar functionality for Text and UTF8 encoded
ByteStrings.
representations. But String has high overhead, so sometimes it isn't suitable
for applications where space usage and performance are important. This
library provides a simpler version of Read's functionality for Text and UTF8
encoded ByteStrings.

2 changes: 1 addition & 1 deletion readable.cabal
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: readable
version: 0.1
synopsis: Read for the modern world
synopsis: Reading from Text and ByteString

description:
Provides a Readable type class for reading data types from ByteString and
Expand Down
14 changes: 7 additions & 7 deletions src/Data/Readable.hs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{-|
The Read type class is very useful for building data types from String
representations. But String has high overhead, so sometimes it isn't
suitable for applications where space usage and performance are important.
This library provides similar functionality for Text and UTF8 encoded
ByteStrings.
representations. But String has high overhead, so sometimes it isn't suitable
for applications where space usage and performance are important. This
library provides a simpler version of Read's functionality for Text and UTF8
encoded ByteStrings.
-}

Expand All @@ -24,9 +24,9 @@ import Data.Word


------------------------------------------------------------------------------
-- | Monadic analog to Read that uses ByteString instead of String. We use
-- MonadPlus to handle parse failure. On error, fromText and fromBS will
-- return mzero. You can use mplus to provide fallback defaults.
-- | ByteString and Text reading using MonadPlus to handle parse failure. On
-- error, fromText and fromBS will return mzero. You can use mplus to provide
-- fallback defaults.
class Readable a where
-- | Reads data from a Text representation.
fromText :: MonadPlus m => Text -> m a
Expand Down

0 comments on commit d97b39c

Please sign in to comment.