aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/concurrency/async.lux
diff options
context:
space:
mode:
Diffstat (limited to 'stdlib/source/documentation/lux/control/concurrency/async.lux')
-rw-r--r--stdlib/source/documentation/lux/control/concurrency/async.lux30
1 files changed, 15 insertions, 15 deletions
diff --git a/stdlib/source/documentation/lux/control/concurrency/async.lux b/stdlib/source/documentation/lux/control/concurrency/async.lux
index 655307522..4899894ef 100644
--- a/stdlib/source/documentation/lux/control/concurrency/async.lux
+++ b/stdlib/source/documentation/lux/control/concurrency/async.lux
@@ -16,64 +16,64 @@
($.default /.apply)
($.default /.monad)
- ($.documentation (/.Async it)
+ ($.definition (/.Async it)
"Represents values produced by asynchronous computations (unlike IO, which is synchronous).")
- ($.documentation (/.Resolver it)
+ ($.definition (/.Resolver it)
(format "The function used to give a value to an async."
\n "Will signal 'true' if the async has been resolved for the 1st time, 'false' otherwise."))
- ($.documentation /.resolved
+ ($.definition /.resolved
"Produces an async that has already been resolved to the given value."
[(resolved value)])
- ($.documentation /.async
+ ($.definition /.async
"Creates a fresh async that has not been resolved yet."
[(async _)])
- ($.documentation /.value
+ ($.definition /.value
"Polls an async for its value.")
- ($.documentation /.upon!
+ ($.definition /.upon!
"Executes the given function as soon as the async has been resolved."
[(upon! function async)])
- ($.documentation /.resolved?
+ ($.definition /.resolved?
"Checks whether an async's value has already been resolved.")
- ($.documentation /.and
+ ($.definition /.and
"Combines the results of both asyncs, in-order."
[(and left right)])
- ($.documentation /.or
+ ($.definition /.or
(format "Yields the results of whichever async gets resolved first."
\n "You can tell which one was resolved first through pattern-matching.")
[(or left right)])
- ($.documentation /.either
+ ($.definition /.either
(format "Yields the results of whichever async gets resolved first."
\n "You cannot tell which one was resolved first.")
[(either left right)])
- ($.documentation /.schedule!
+ ($.definition /.schedule!
(format "Runs an I/O computation on its own thread (after a specified delay)."
\n "Returns an async that will eventually host its result.")
[(schedule! milli_seconds computation)])
- ($.documentation /.future
+ ($.definition /.future
(format "Runs an I/O computation on its own thread."
\n "Returns an async that will eventually host its result.")
[(future computation)])
- ($.documentation /.after
+ ($.definition /.after
"Delivers a value after a certain period has passed."
[(after milli_seconds value)])
- ($.documentation /.delay
+ ($.definition /.delay
"An async that will be resolved after the specified amount of milli-seconds."
[(delay milli_seconds)])
- ($.documentation /.within
+ ($.definition /.within
"Wait for an async to be resolved within the specified amount of milli-seconds."
[(within milli_seconds async)])]
[]))