aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/region.lux
diff options
context:
space:
mode:
authorEduardo Julian2022-07-08 17:47:23 -0400
committerEduardo Julian2022-07-08 17:47:23 -0400
commit7976268575e7c6910dfba2d2733e8cc1883678e7 (patch)
tree0ce156081612235c0df5e2ad9167be3fc5d75c6c /stdlib/source/documentation/lux/control/region.lux
parent39325bb36c6f6459c861ef12f9e99b9e66b52594 (diff)
Re-named the "documentation" macro to "definition".
Diffstat (limited to 'stdlib/source/documentation/lux/control/region.lux')
-rw-r--r--stdlib/source/documentation/lux/control/region.lux12
1 files changed, 6 insertions, 6 deletions
diff --git a/stdlib/source/documentation/lux/control/region.lux b/stdlib/source/documentation/lux/control/region.lux
index 5432ab07f..55d903d6c 100644
--- a/stdlib/source/documentation/lux/control/region.lux
+++ b/stdlib/source/documentation/lux/control/region.lux
@@ -17,27 +17,27 @@
($.default /.apply)
($.default /.monad)
- ($.documentation (/.Region r ! it)
+ ($.definition (/.Region r ! it)
(format "A region where resources may be be claimed and where a side-effecting computation may be performed."
\n "Every resource is paired with a function that knows how to clean/reclaim it, to make sure there are no leaks."))
- ($.documentation /.run!
+ ($.definition /.run!
"Executes a region-based computation, with a side-effect determined by the monad."
[(run! monad computation)])
- ($.documentation /.acquire!
+ ($.definition /.acquire!
"Acquire a resource while pairing it a function that knows how to reclaim it."
[(acquire! monad cleaner value)])
- ($.documentation /.failure
+ ($.definition /.failure
"Immediately fail with this 'message'."
[(failure monad error)])
- ($.documentation /.except
+ ($.definition /.except
"Fail by throwing/raising an exception."
[(except monad exception message)])
- ($.documentation /.lifted
+ ($.definition /.lifted
"Lift an effectful computation into a region-based computation."
[(lifted monad operation)])]
[]))