aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/library/lux/control/region.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/library/lux/control/region.lux')
-rw-r--r--stdlib/source/library/lux/control/region.lux11
1 files changed, 2 insertions, 9 deletions
diff --git a/stdlib/source/library/lux/control/region.lux b/stdlib/source/library/lux/control/region.lux
index 191c6a328..9d9f579c0 100644
--- a/stdlib/source/library/lux/control/region.lux
+++ b/stdlib/source/library/lux/control/region.lux
@@ -19,8 +19,6 @@
(-> r (! (Try Any))))
(type: .public (Region r ! a)
- {#.doc (example "A region where resources may be be claimed and where a side-effecting computation may be performed."
- "Every resource is paired with a function that knows how to clean/reclaim it, to make sure there are no leaks.")}
(-> [r (List (Cleaner r !))]
(! [(List (Cleaner r !))
(Try a)])))
@@ -54,7 +52,6 @@
(exception.except ..clean_up_error [error output])))
(def: .public (run! monad computation)
- {#.doc (example "Executes a region-based computation, with a side-effect determined by the monad.")}
(All [! a]
(-> (Monad !) (All [r] (Region r ! a))
(! (Try a))))
@@ -65,7 +62,6 @@
(\ ! map (list\fold clean output)))))
(def: .public (acquire! monad cleaner value)
- {#.doc (example "Acquire a resource while pairing it a function that knows how to reclaim it.")}
(All [! a] (-> (Monad !) (-> a (! (Try Any))) a
(All [r] (Region r ! a))))
(function (_ [region cleaners])
@@ -97,7 +93,7 @@
(All [r] (Apply (Region r !)))))
(def: &functor
- (..functor (get@ #monad.&functor super)))
+ (..functor (value@ #monad.&functor super)))
(def: (apply ff fa)
(function (_ [region cleaners])
@@ -122,7 +118,7 @@
(All [r] (Monad (Region r !)))))
(def: &functor
- (..functor (get@ #monad.&functor super)))
+ (..functor (value@ #monad.&functor super)))
(def: (in value)
(function (_ [region cleaners])
@@ -140,7 +136,6 @@
(in [cleaners (#try.Failure error)]))))))
(def: .public (failure monad error)
- {#.doc (example "Immediately fail with this 'message'.")}
(All [! a]
(-> (Monad !) Text
(All [r] (Region r ! a))))
@@ -148,14 +143,12 @@
(\ monad in [cleaners (#try.Failure error)])))
(def: .public (except monad exception message)
- {#.doc (example "Fail by throwing/raising an exception.")}
(All [! e a]
(-> (Monad !) (Exception e) e
(All [r] (Region r ! a))))
(failure monad (exception.error exception message)))
(def: .public (lifted monad operation)
- {#.doc (example "Lift an effectful computation into a region-based computation.")}
(All [! a]
(-> (Monad !) (! a)
(All [r] (Region r ! a))))