sayo-hs/heftia
1
1
Fork 0
mirror of https://github.com/sayo-hs/heftia.git synced 2024-11-26 23:05:04 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

[fix] incorrect type signatures in documentation.

Browse Source
This commit is contained in:
Yamada Ryo 2024-10-11 04:22:17 +09:00
parent 8816f1c33e
commit 84e2b6a96d
No known key found for this signature in database
GPG Key ID: AAE3C7A542B02DBF
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
heftia/src/Control/Monad/Hefty.hs
View File

@ -20,6 +20,9 @@ effect @Log@ for logging and the higher-order effect @Span@ for representing
named spans in a program.
@
{\-# LANGUAGE AllowAmbiguousTypes #-\}
{\-# LANGUAGE TemplateHaskell #-\}
import "Control.Monad.Hefty"
import Prelude hiding (log, span)
@ -170,13 +173,13 @@ prog = 'runEff' . runLog . runSpan $ do
* Non-recursive continuational stateful interpretation functions like 'interpretWith' cannot be used unless the higher-order effects are empty:
@
'interpretWith' :: e ~> Eff '[] ef => 'Eff' '[] (e ': ef) ~> 'Eff' '[] ef
'interpretWith' :: e t'Control.Effect.~>' 'Eff' '[] ef -> 'Eff' '[] (e ': ef) t'Control.Effect.~>' 'Eff' '[] ef
@
* The @Rec@ versions can be used even when @eh@ is not empty.
@
'interpretRecWith' :: e ~> 'Eff' eh (e ': ef) ~> 'Eff' eh ef
'interpretRecWith' :: e t'Control.Effect.~>' 'Eff' eh ef -> 'Eff' eh (e ': ef) t'Control.Effect.~>' 'Eff' eh ef
@
* When using this type of function, pay attention to their /reset semantics/. This is discussed later.