]> git.immae.eu Git - github/fretlink/text-pipes.git/commitdiff
generalized signatures
authormichaelt <what_is_it_to_do_anything@yahoo.com>
Wed, 19 Feb 2014 16:15:54 +0000 (11:15 -0500)
committermichaelt <what_is_it_to_do_anything@yahoo.com>
Wed, 19 Feb 2014 16:15:54 +0000 (11:15 -0500)
Pipes/Text.hs
Pipes/Text/Encoding.hs
Pipes/Text/IO.hs

index b90948f99636ab0bc8d72ac6321debe3207446c7..575c9877cbf9b01cbc1b26dd1986fcfed3d03a07 100644 (file)
@@ -290,7 +290,7 @@ unpack = for cat (\t -> yield (T.unpack t))
 
 -- | @toCaseFold@, @toLower@, @toUpper@ and @stripStart@ are standard 'Text' utilities, 
 -- here acting as 'Text' pipes, rather as they would  on a lazy text
-toCaseFold :: Monad m => Pipe Text Text m ()
+toCaseFold :: Monad m => Pipe Text Text m r
 toCaseFold = P.map T.toCaseFold
 {-# INLINEABLE toCaseFold #-}
 
@@ -300,7 +300,7 @@ toCaseFold = P.map T.toCaseFold
 
 
 -- | lowercase incoming 'Text'
-toLower :: Monad m => Pipe Text Text m ()
+toLower :: Monad m => Pipe Text Text m r
 toLower = P.map T.toLower
 {-# INLINEABLE toLower #-}
 
index 4311ad1d6de73b8555799fc82675fa8af4a667cd..d727c2c5a0b890ab16696c84c630504618cb7521 100644 (file)
@@ -12,7 +12,7 @@ module Pipes.Text.Encoding
     -- $lenses
     Codec
     , decode
-    -- * Viewing the Text in a ByteString
+    -- * \'Viewing\' the Text in a byte stream
     -- $codecs
     , utf8
     , utf8Pure
@@ -57,7 +57,6 @@ import Control.Monad (join)
 import Data.Word (Word8)
 import Pipes
 
-
 type Lens' a b = forall f . Functor f => (b -> f b) -> (a -> f a)
 
 {- $lenses
@@ -131,11 +130,11 @@ decode codec a = getConstant (codec Constant a)
 
 >   zoom utf8 drawChar :: Monad m => StateT (Producer ByteString m r) m (Maybe Char)
 
-    or, with the type synonymn of @Pipes.Parse@:
+    or, using the type synonymn from @Pipes.Parse@:
     
 >   zoom utf8 drawChar :: Monad m => Parser ByteString m (Maybe Char)
 
-    Thus we can define ByteString like this:
+    Thus we can define a ByteString parser like this:
     
 >   withNextByte :: Parser ByteString m (Maybe Char, Maybe Word8))) 
 >   withNextByte = do char_ <- zoom utf8 Text.drawChar
index 57c463868a6c1f98ce1877b582165644b2533501..23aff6956422c08fb56bdf23cda50f7f33b089cf 100644 (file)
@@ -81,11 +81,11 @@ To stream from files, the following is perhaps more Prelude-like (note that it u
 
     * Like the functions in @Data.Text.IO@, they attempt to work with the system encoding. 
   
-    * Like the functions in @Data.Text.IO@, they are slower than ByteString operations. Where
+    * Like the functions in @Data.Text.IO@, they significantly slower than ByteString operations. Where
        you know what encoding you are working with, use @Pipes.ByteString@ and @Pipes.Text.Encoding@ instead,
        e.g. @view utf8 Bytes.stdin@ instead of @Text.stdin@
   
-    * Like the functions in  @Data.Text.IO@ , they use Text exceptions. 
+    * Like the functions in  @Data.Text.IO@ , they use Text exceptions, not the standard Pipes protocols
 
    Something like