circuithub/rel8
1
1
Fork 0
mirror of https://github.com/circuithub/rel8.git synced 2024-09-11 16:05:41 +03:00
Code Issues Projects Releases Wiki Activity

Reword Evaluate documentation

Browse Source
This commit is contained in:
Shane O'Brien 2021-06-18 17:21:55 +01:00
parent 421fe3ff76
commit b4a542a85d
No known key found for this signature in database
GPG Key ID: 35A00ED1B695C1A1
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Rel8/Query/Evaluate.hs
View File

@ -48,9 +48,9 @@ data Evaluations = Evaluations
-- | Some PostgreSQL functions, such as 'Rel8.nextval', have side effects,
-- breaking the referential transparency we would otherwise enjoy.
--
-- To try to recover our ability to reason about such expressions, 'Rel8'
-- provides the 'Evaluate' monad, which allows us to control the evaluation
-- order of side-effects by sequencing them monadically.
-- To try to recover our ability to reason about such expressions, 'Evaluate'
-- allows us to control the evaluation order of side-effects by sequencing
-- them monadically.
type Evaluate :: Type -> Type
newtype Evaluate a = Evaluate (State Evaluations a)
deriving newtype (Functor, Apply, Applicative, Monad)
@ -61,8 +61,8 @@ instance Bind Evaluate where
-- | 'eval' takes expressions that could potentially have side effects and
-- lifts them into the 'Evaluate' monad. The resulting expressions has no side
-- effetcs and can safely be reused.
-- \"runs\" them in the 'Evaluate' monad. The returned expressions have no
-- side effetcs and can safely be reused.
eval :: Table Expr a => a -> Evaluate a
eval a = Evaluate $ do
Evaluations {tag, bindings} <- get