Permalink
Browse files

Small doc changes

  • Loading branch information...
1 parent f559134 commit d97b39c6beef758728b3a5d74fc6a6ecf322e518 @mightybyte committed Aug 24, 2012
Showing with 12 additions and 12 deletions.
  1. +4 −4 README.md
  2. +1 −1 readable.cabal
  3. +7 −7 src/Data/Readable.hs
View
@@ -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.
View
@@ -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
View
@@ -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.
-}
@@ -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

0 comments on commit d97b39c

Please sign in to comment.