on master help sign in
Improve haddocks for reviewEncoder
commit584f1ce80d5ac632e1bd754d4ee5a6983cd525c8 authorElliot Cameron <3noch@users.noreply.github.com> dateTue 28 Apr 2020, 16:43 (6 years ago) parent66e7444
1 file changed+2−2
lib/route/src/Obelisk/Route.hs+2−2
lib/route/src/Obelisk/Route.hs+2−2
@@ -826,13 +826,13 @@ _R variant = dSumGEqPrism variant . iso runIdentity Identity
826826{-# DEPRECATED prismEncoder "Use reviewEncoder instead" #-}
827827-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
828828-- if the prism doesn't match.
829−-- This encoder is contravariant like 'review': prismEncoder (f . g) = prismEncoder g . prismEncoder f
829+-- This encoder is contravariant like 'review': @prismEncoder (f . g) = prismEncoder g . prismEncoder f@
830830prismEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
831831prismEncoder = reviewEncoder
832832
833833-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
834834-- if the prism doesn't match.
835−-- This encoder is contravariant like 'review': prismEncoder (f . g) = prismEncoder g . prismEncoder f
835+-- This encoder is contravariant like 'review': @reviewEncoder (f . g) = reviewEncoder g . reviewEncoder f@
836836reviewEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
837837reviewEncoder p = unsafeMkEncoder $ EncoderImpl
838838 { _encoderImpl_encode= view (re p)