aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/region.lux
diff options
context:
space:
mode:
authorEduardo Julian2022-06-26 18:37:05 -0400
committerEduardo Julian2022-06-26 18:37:05 -0400
commit9f6505491e8a5c8a159ce094fe0af6f4fef0c5cf (patch)
treed497c163e477406a388460eedea80fdd6ee9748a /stdlib/source/documentation/lux/control/region.lux
parent3053fd79bc6ae42415298ee056a268dc2c9b690c (diff)
Re-named "format/lux/data/binary.Writer" to "Format".
Diffstat (limited to 'stdlib/source/documentation/lux/control/region.lux')
-rw-r--r--stdlib/source/documentation/lux/control/region.lux60
1 files changed, 27 insertions, 33 deletions
diff --git a/stdlib/source/documentation/lux/control/region.lux b/stdlib/source/documentation/lux/control/region.lux
index dcfed365c..c0da27237 100644
--- a/stdlib/source/documentation/lux/control/region.lux
+++ b/stdlib/source/documentation/lux/control/region.lux
@@ -1,7 +1,7 @@
(.require
[library
[lux (.except if loop)
- ["$" documentation (.only documentation:)]
+ ["$" documentation]
[data
[text (.only \n)
["%" \\format (.only format)]]]
@@ -10,42 +10,36 @@
[\\library
["[0]" /]])
-(documentation: (/.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!
- "Executes a region-based computation, with a side-effect determined by the monad."
- [(run! monad computation)])
-
-(documentation: /.acquire!
- "Acquire a resource while pairing it a function that knows how to reclaim it."
- [(acquire! monad cleaner value)])
-
-(documentation: /.failure
- "Immediately fail with this 'message'."
- [(failure monad error)])
-
-(documentation: /.except
- "Fail by throwing/raising an exception."
- [(except monad exception message)])
-
-(documentation: /.lifted
- "Lift an effectful computation into a region-based computation."
- [(lifted monad operation)])
-
(.def .public documentation
(.List $.Module)
($.module /._
""
- [..Region
- ..run!
- ..acquire!
- ..failure
- ..except
- ..lifted
- ($.default /.clean_up_error)
+ [($.default /.clean_up_error)
($.default /.functor)
($.default /.apply)
- ($.default /.monad)]
+ ($.default /.monad)
+
+ ($.documentation (/.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!
+ "Executes a region-based computation, with a side-effect determined by the monad."
+ [(run! monad computation)])
+
+ ($.documentation /.acquire!
+ "Acquire a resource while pairing it a function that knows how to reclaim it."
+ [(acquire! monad cleaner value)])
+
+ ($.documentation /.failure
+ "Immediately fail with this 'message'."
+ [(failure monad error)])
+
+ ($.documentation /.except
+ "Fail by throwing/raising an exception."
+ [(except monad exception message)])
+
+ ($.documentation /.lifted
+ "Lift an effectful computation into a region-based computation."
+ [(lifted monad operation)])]
[]))