From 7da7dbc8dbf217441300cc21483c65624860e38d Mon Sep 17 00:00:00 2001 From: michaelt Date: Sat, 6 Feb 2016 17:19:30 -0500 Subject: [PATCH] cabal file commentary --- pipes-text.cabal | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pipes-text.cabal b/pipes-text.cabal index fe77644..8ddb4e2 100644 --- a/pipes-text.cabal +++ b/pipes-text.cabal @@ -5,11 +5,15 @@ description: * This organization of the package follows the rule . * @pipes-text : pipes-bytestring :: text : bytestring@ . - Familiarity with the other three packages should give one an idea what to expect where. The package has three modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. + Familiarity with the other three packages should give one an idea what to expect where. The package has three principal modules, @Pipes.Text@ , @Pipes.Text.Encoding@ and @Pipes.Text.IO@; the division has more or less the significance it has in the @text@ library. A fourth module @Pipes.Prelude.Text@ is explained below. . Note that the module @Pipes.Text.IO@ is present as a convenience (as is @Data.Text.IO@). Official pipes IO would use @Pipes.ByteString@ together with the bytestring decoding functions in @Pipes.Text.Encoding@. In particular, the @Pipes.Text.IO@ functions use Text exceptions. . - @Pipes.Text.IO@ uses version 0.11.3 or later of the @text@ library. It thus works with the version of @text@ that came with the 2013 Haskell Platform. To use an older @text@, install with the flag @-fnoio@ + The fourth module @Pipes.Prelude.Text@ just exports line-based Text producers and consumers as a drop-in replacement for the String material in @Pipes.Prelude@ and @Pipes.Safe.Prelude@. They can be used as one uses @Pipes.Prelude@ without reference to the rest of this package. See the caveats in the documentation for the module. + . + @Pipes.Text.IO@ and @Pipes.Prelude.Text@ use version 0.11.3 or later of the @text@ library. It thus works with the version of @text@ that came with the 2013 Haskell Platform. To use an older @text@, install with the flag @-fnoio@ + + homepage: https://github.com/michaelt/text-pipes bug-reports: https://github.com/michaelt/text-pipes/issues -- 2.41.0