diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,6 +1,15 @@ # ChangeLog / ReleaseNotes +## Version 0.1.0.2 + +* Bugfix release. +* Bugfix: Unable to compile with transformers >= 0.4 (again). +* Minor documentation updates. +* Uploaded to [Hackage][] + + + ## Version 0.1.0.1 * Bugfix release. diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Endo +[![Hackage](http://img.shields.io/hackage/v/endo.svg)][Hackage: endo] [![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)][Haskell.org] [![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)][tl;dr Legal: BSD3] @@ -173,13 +174,22 @@ main = execParser (info options fullDesc) >>= print ```` -Parsers for individual options and flags are wrapped in 'IdentityT', because -there is no `instance FoldEndoArgs r => FoldEndoArgs (Parser r)`, but there is -`instance FoldEndoArgs r => FoldEndoArgs (IdentityT r)`. +Parsers for individual options and flags are wrapped in `IdentityT`, because +there is no following instance: -Functions used by the above code: +````Haskell +instance FoldEndoArgs r => FoldEndoArgs (Parser r) +```` +But there is: + ````Haskell +instance (Applicative f, FoldEndoArgs r) => FoldEndoArgs (IdentityT f r) +```` + +Functions used by the above code example: + +````Haskell outputOption :: IdentityT Parser (Maybe (E Config)) outputOption = IdentityT . optional . option (set outputFile <$> parseFilePath) @@ -227,22 +237,23 @@ ```` -Building Options ----------------- +## Building Options * `-fpedantic` (disabled by default) Pass additional warning flags to GHC. -Contributions -------------- +## Contributions Contributions, pull requests and bug reports are welcome! Please don't be afraid to contact author using GitHub or by e-mail. +[Hackage: endo]: + http://hackage.haskell.org/package/endo + "endo package on Hackage" [Hackage: lens]: http://hackage.haskell.org/package/lens "lens package on Hackage" diff --git a/endo.cabal b/endo.cabal --- a/endo.cabal +++ b/endo.cabal @@ -1,12 +1,12 @@ name: endo -version: 0.1.0.1 +version: 0.1.0.2 synopsis: Endomorphism utilities. description: Package defines extra functions for 'Data.Monoid.Endo' data type, and also generic endomorphism folding machinery. Generic endomorphism folding can be used for various purposes, including as a builder. . - Here is an example how to use with + Here is an example how to use it with package: . @@ -113,4 +113,4 @@ source-repository this type: git location: git://github.com/trskop/endo.git - tag: 0.1.0.1 + tag: 0.1.0.2 diff --git a/example/Example/Config.hs b/example/Example/Config.hs --- a/example/Example/Config.hs +++ b/example/Example/Config.hs @@ -3,7 +3,7 @@ -- | -- Module: $HEADER$ -- Description: Simple example of Config data type. --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example/Config/Lens.hs b/example/Example/Config/Lens.hs --- a/example/Example/Config/Lens.hs +++ b/example/Example/Config/Lens.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Simple setters for Config data type. --- Copyright: (c) 2013-2015 Peter Trsko +-- Copyright: (c) 2013-2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example/Config/Setters.hs b/example/Example/Config/Setters.hs --- a/example/Example/Config/Setters.hs +++ b/example/Example/Config/Setters.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Simple setters for Config data type. --- Copyright: (c) 2013-2015 Peter Trsko +-- Copyright: (c) 2013-2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example1.hs b/example/Example1.hs --- a/example/Example1.hs +++ b/example/Example1.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 1 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example2.hs b/example/Example2.hs --- a/example/Example2.hs +++ b/example/Example2.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 2 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example3.hs b/example/Example3.hs --- a/example/Example3.hs +++ b/example/Example3.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 3 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example4.hs b/example/Example4.hs --- a/example/Example4.hs +++ b/example/Example4.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 4 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example5.hs b/example/Example5.hs --- a/example/Example5.hs +++ b/example/Example5.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 5 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example6.hs b/example/Example6.hs --- a/example/Example6.hs +++ b/example/Example6.hs @@ -3,7 +3,7 @@ -- | -- Module: $HEADER$ -- Description: Example 6 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/example/Example7.hs b/example/Example7.hs --- a/example/Example7.hs +++ b/example/Example7.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Example 7 --- Copyright: (c) 2015 Peter Trsko +-- Copyright: (c) 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com diff --git a/src/Data/Monoid/Endo.hs b/src/Data/Monoid/Endo.hs --- a/src/Data/Monoid/Endo.hs +++ b/src/Data/Monoid/Endo.hs @@ -2,7 +2,7 @@ -- | -- Module: $HEADER$ -- Description: Utilities for Endo data type. --- Copyright: (c) 2013-2015 Peter Trsko +-- Copyright: (c) 2013-2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com @@ -31,7 +31,7 @@ import Data.Function.Between ((~@~), (<~@~)) --- | Type synonym for endomorphsm; it can be used simplify type signatures. +-- | Type synonym for endomorphsm; it can be used to simplify type signatures. type E a = a -> a -- | Transform function wrapped in 'Endo'. diff --git a/src/Data/Monoid/Endo/Fold.hs b/src/Data/Monoid/Endo/Fold.hs --- a/src/Data/Monoid/Endo/Fold.hs +++ b/src/Data/Monoid/Endo/Fold.hs @@ -17,7 +17,7 @@ -- | -- Module: $HEADER$ -- Description: Generic folding for various endomorphism representations. --- Copyright: (c) 2014, 2015 Peter Trsko +-- Copyright: (c) 2014, 2015 Peter Trško -- License: BSD3 -- -- Maintainer: peter.trsko@gmail.com @@ -226,7 +226,7 @@ , FoldEndoArgs r ) => FoldEndoArgs (ExceptT e m r) where - type ResultOperatesOn (ExceptT e f r) = ResultOperatesOn r + type ResultOperatesOn (ExceptT e m r) = ResultOperatesOn r foldEndoArgs = pure . foldEndoArgs dualFoldEndoArgs = pure . dualFoldEndoArgs #endif @@ -867,10 +867,19 @@ -- Config {_verbosity = Annoying, _outputFile = "an.out.put"} -- -- Parsers for individual options and flags are wrapped in 'IdentityT', because --- there is no @instance 'FoldEndoArgs' r =\> 'FoldEndoArgs' (Parser r)@, but --- there is @instance 'FoldEndoArgs' r =\> 'FoldEndoArgs' ('IdentityT' r)@. +-- there is no following instance: -- --- Functions used by the above code: +-- @ +-- instance 'FoldEndoArgs' r => 'FoldEndoArgs' (Parser r) +-- @ +-- +-- But there is: +-- +-- @ +-- instance ('Applicative' f, 'FoldEndoArgs' r) => 'FoldEndoArgs' ('IdentityT' f r) +-- @ +-- +-- Functions used by the above code example: -- -- @ -- outputOption :: 'IdentityT' Parser (Maybe ('Data.Monoid.Endo.E' Config))