]> git.immae.eu Git - github/fretlink/text-pipes.git/commitdiff
Readme corrected
authormichaelt <what_is_it_to_do_anything@yahoo.com>
Tue, 22 Oct 2013 22:52:50 +0000 (18:52 -0400)
committermichaelt <what_is_it_to_do_anything@yahoo.com>
Tue, 22 Oct 2013 22:52:50 +0000 (18:52 -0400)
Pipes/Text.hs
README.md

index b0d90f0e706ff1dd21998174925edc9f203eac34..022855f9a043ddd550ea03bcf57a4e3bef730dc8 100644 (file)
@@ -158,7 +158,7 @@ import Foreign.C.Error (Errno(Errno), ePIPE)
 import qualified GHC.IO.Exception as G
 import Pipes
 import qualified Pipes.ByteString.Parse as PBP
-import Data.Text.Pipes.Parse (
+import Pipes.Text.Parse (
     nextChar, drawChar, unDrawChar, peekChar, isEndOfChars )
 import Pipes.Core (respond, Server')
 import qualified Pipes.Parse as PP
@@ -318,33 +318,33 @@ encodeUtf8 :: Monad m => Pipe Text ByteString m r
 encodeUtf8 = P.map TE.encodeUtf8
 {-# INLINEABLE encodeUtf8 #-}
 
---| Transform a Pipe of 'String's into one of 'Text' chunks
+-- | Transform a Pipe of 'String's into one of 'Text' chunks
 pack :: Monad m => Pipe String Text m r
 pack = P.map T.pack
 {-# INLINEABLE pack #-}
 
---| Transforma a Pipes of 'Text' chunks into one of 'String's
+-- | Transforma a Pipes of 'Text' chunks into one of 'String's
 unpack :: Monad m => Pipe Text String m r
 unpack = P.map T.unpack
 {-# INLINEABLE unpack #-}
 
---| @toCaseFold@, @toLower@, @toUpper@ and @stripStart@ are standard 'Text' utility, 
+-- | @toCaseFold@, @toLower@, @toUpper@ and @stripStart@ are standard 'Text' utility, 
 -- here acting on a 'Text' pipe, rather as they would  on a lazy text
 toCaseFold :: Monad m => Pipe Text Text m ()
 toCaseFold = P.map T.toCaseFold
 {-# INLINEABLE toCaseFold #-}
 
---| lowercase incoming 'Text'
+-- | lowercase incoming 'Text'
 toLower :: Monad m => Pipe Text Text m ()
 toLower = P.map T.toLower
 {-# INLINEABLE toLower #-}
 
---| uppercase incoming 'Text'
+-- | uppercase incoming 'Text'
 toUpper :: Monad m => Pipe Text Text m ()
 toUpper = P.map T.toUpper
 {-# INLINEABLE toUpper #-}
 
---| Remove leading white space from an incoming succession of 'Text's 
+-- | Remove leading white space from an incoming succession of 'Text's 
 stripStart :: Monad m => Pipe Text Text m r
 stripStart = do
     chunk <- await
index 71550b87cc50488a2e0d2d8a5bef2052883d7186..6aac0ad6bced7eb7be354f30060a7820bd408109 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,8 @@
-text-pipes
+pipes-text
 ==========
 
-Text pipes, somehow to be fused with [`pipes-text`](https://github.com/ibotty/pipes-text) 
-which uses an upcoming version of the `text` library to link bytestring and text.
-
-This module follows the pattern of `pipes-bytestring` (largely by skillful use of the
-expedient of regular expressions), and adds a few `pipes-prelude`-like operations.
+These modules `Pipes.Text` and `Pipes.Text.Parse` use materials from [`pipes-text`](https://github.com/ibotty/pipes-text) and 
+otherwise follows the pattern of [`pipes-bytestring`](https://github.com/Gabriel439/Haskell-Pipes-ByteString-Library), adding a few `pipes-prelude`-like operations.
 
 
      >>> runEffect $ stdinLn >-> P.takeWhile (/= "quit") >-> stdoutLn
@@ -13,7 +10,6 @@ expedient of regular expressions), and adds a few `pipes-prelude`-like operation
      hi
      quit<Return>
      >>> runSafeT $ runEffect $ readFile "README.md" >-> map toUpper >-> hoist lift stdout
-     TEXT-PIPES
+     PIPES-TEXT
      ==========
-     TEXT PIPES, SOMEHOW TO BE FUSED WITH `PIPES-TEXT`.
      ...
\ No newline at end of file