23d96a4 · effectful · git.iko.soy

git.iko.soy/effectful

Fix haddock references

commit23d96a46334ca990ebe8ed0a7e9660046d3f9f08 authorAndrzej Rybczak <andrzej@rybczak.net> dateMon 14 Jun 2021, 23:31 (5 years ago) parente190279

8 files changed+10−10

compare with master

unifiedsplit

src/Effectful/Class/Reader.hs+1−1 src/Effectful/Class/State.hs+1−1 src/Effectful/Class/Writer.hs+1−1 src/Effectful/Internal/Env.hs+1−1 src/Effectful/Internal/Has.hs+2−2 src/Effectful/State.hs+2−2 src/Effectful/State/Dynamic.hs+1−1 src/Effectful/State/MVar.hs+1−1

src/Effectful/Class/Reader.hs+1−1

@@ -12,7 +12,7 @@ import Effectful.Internal.Monad

1212import qualified Effectful.Reader as R

1313

1414-- | Compatiblity layer for a transition period from MTL-style effect handling

15−-- to 'Effective.Eff'.

15+-- to 'Effectful.Eff'.

1616class Monad m => MonadReader r m where

1717 {-# MINIMAL (ask | reader), local #-}

1818 ask :: m r

src/Effectful/Class/State.hs+1−1

@@ -8,7 +8,7 @@ import Effectful.Internal.Monad

88import qualified Effectful.State.Dynamic as S

1010-- | Compatiblity layer for a transition period from MTL-style effect handling

11−-- to 'Effective.Eff'.

11+-- to 'Effectful.Eff'.

1212class Monad m => MonadState s m where

1313 {-# MINIMAL state | get, put #-}

1414

src/Effectful/Class/Writer.hs+1−1

@@ -9,7 +9,7 @@ import Effectful.Internal.Monad

99import qualified Effectful.Writer as W

1010

1111-- | Compatiblity layer for a transition period from MTL-style effect handling

12−-- to 'Effective.Eff'.

12+-- to 'Effectful.Eff'.

1313class Monad m => MonadWriter w m where

1414 {-# MINIMAL (writer | tell), listen #-}

1515

src/Effectful/Internal/Env.hs+1−1

@@ -1,5 +1,5 @@

11{-# OPTIONS_HADDOCK not-home #-}

2−-- | The enviroment for 'Effective.Internal.Monad.Eff'.

2+-- | The enviroment for 'Effectful.Internal.Monad.Eff'.

33--

44-- This module is intended for internal use only, and may change without warning

55-- in subsequent releases.

src/Effectful/Internal/Has.hs+2−2

@@ -1,7 +1,7 @@

11{-# LANGUAGE AllowAmbiguousTypes #-}

22{-# LANGUAGE UndecidableInstances #-}

33{-# OPTIONS_HADDOCK not-home #-}

4−-- | Type-safe indexing for 'Effective.Internal.Monad.Env'.

4+-- | Type-safe indexing for 'Effectful.Internal.Monad.Env'.

55--

66-- This module is intended for internal use only, and may change without warning

77-- in subsequent releases.

@@ -30,6 +30,6 @@ instance {-# OVERLAPPING #-} e :> (e : es) where

3030instance e :> es => e :> (x : es) where

3131 ixOf = 1 + ixOf @e @es

3232

33−-- | Get position of @e@ in the 'Effective.Internal.Env.Env'.

33+-- | Get position of @e@ in the 'Effectful.Internal.Env.Env'.

3434ixEnv :: forall e es. e :> es => Int -> Int

3535ixEnv n = n - ixOf @e @es - 1

src/Effectful/State.hs+2−2

@@ -6,8 +6,8 @@

66--

77-- - not suitable for sharing between multiple threads.

88--

9−-- If you plan to do the latter, have a look at "Effective.State.MVar" or

10−-- "Effective.State.Dynamic".

9+-- If you plan to do the latter, have a look at "Effectful.State.MVar" or

10+-- "Effectful.State.Dynamic".

1111--

1212module Effectful.State

1313 ( State

src/Effectful/State/Dynamic.hs+1−1

@@ -1,7 +1,7 @@

11-- | The 'State' as an effect with dynamic dispatch.

22--

33-- It's not clear in which situation it's beneficial to use this instead of

4−-- "Effective.State" or "Effective.State.MVar" as you either:

4+-- "Effectful.State" or "Effectful.State.MVar" as you either:

55--

66-- - Share state between threads and need the synchonized version.

77--

src/Effectful/State/MVar.hs+1−1

@@ -2,7 +2,7 @@

22--

33-- Represented as an MVar underneath, therefore:

44--

5−-- - slower than "Effective.State"

5+-- - slower than "Effectful.State"

66--

77-- - suitable for sharing between multiple threads.

88--