diff options
Diffstat (limited to '')
7 files changed, 59 insertions, 59 deletions
diff --git a/stdlib/source/documentation/lux/control/concurrency/actor.lux b/stdlib/source/documentation/lux/control/concurrency/actor.lux index 16e529ca9..c9df4c40d 100644 --- a/stdlib/source/documentation/lux/control/concurrency/actor.lux +++ b/stdlib/source/documentation/lux/control/concurrency/actor.lux @@ -17,44 +17,44 @@ ($.default /.alive?) ($.default /.obituary') - ($.documentation (/.Actor state) + ($.definition (/.Actor state) "An entity that can react to messages (mail) sent to it concurrently.") - ($.documentation (/.Mail state) + ($.definition (/.Mail state) "A one-way message sent to an actor, without expecting a reply.") - ($.documentation (/.Obituary state) + ($.definition (/.Obituary state) "Details on the death of an actor.") - ($.documentation (/.Behavior state) + ($.definition (/.Behavior state) "An actor's behavior when mail is received.") - ($.documentation /.spawn! + ($.definition /.spawn! "Given a behavior and initial state, spawns an actor and returns it.") - ($.documentation /.obituary + ($.definition /.obituary "Await for an actor to stop working.") - ($.documentation /.mail! + ($.definition /.mail! "Send mail to an actor.") - ($.documentation (/.Message state output) + ($.definition (/.Message state output) "A two-way message sent to an actor, expecting a reply.") - ($.documentation /.tell! + ($.definition /.tell! "Communicate with an actor through message-passing.") - ($.documentation /.default + ($.definition /.default "Default actor behavior.") - ($.documentation /.poison! + ($.definition /.poison! (format "Kills the actor by sending mail that will kill it upon processing," \n "but allows the actor to handle previous mail.")) - ($.documentation /.Stop + ($.definition /.Stop "A signal to stop an actor from observing a channel.") - ($.documentation /.observe! + ($.definition /.observe! (format "Use an actor to observe a channel by transforming each datum" \n "flowing through the channel into mail the actor can process." \n "Can stop observing the channel by executing the Stop value."))] 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)])] [])) diff --git a/stdlib/source/documentation/lux/control/concurrency/atom.lux b/stdlib/source/documentation/lux/control/concurrency/atom.lux index 77dcba913..b02aaff9a 100644 --- a/stdlib/source/documentation/lux/control/concurrency/atom.lux +++ b/stdlib/source/documentation/lux/control/concurrency/atom.lux @@ -15,19 +15,19 @@ [($.default /.atom) ($.default /.read!) - ($.documentation (/.Atom it) + ($.definition (/.Atom it) "Atomic references that are safe to mutate concurrently.") - ($.documentation /.compare_and_swap! + ($.definition /.compare_and_swap! (format "Only mutates an atom if you can present its current value." \n "That guarantees that atom was not updated since you last read from it.")) - ($.documentation /.update! + ($.definition /.update! (format "Updates an atom by applying a function to its current value." \n "If it fails to update it (because some other process wrote to it first), it will retry until it succeeds." \n "The retries will be done with the new values of the atom, as they show up.")) - ($.documentation /.write! + ($.definition /.write! (format "Writes the given value to an atom." \n "If it fails to write it (because some other process wrote to it first), it will retry until it succeeds."))] [])) diff --git a/stdlib/source/documentation/lux/control/concurrency/frp.lux b/stdlib/source/documentation/lux/control/concurrency/frp.lux index 2f89cf7bd..ed095f73c 100644 --- a/stdlib/source/documentation/lux/control/concurrency/frp.lux +++ b/stdlib/source/documentation/lux/control/concurrency/frp.lux @@ -24,33 +24,33 @@ ($.default /.distinct) ($.default /.list) - ($.documentation (/.Channel it) + ($.definition (/.Channel it) "An asynchronous channel to distribute values.") - ($.documentation (/.Sink it) + ($.definition (/.Sink it) "The tail-end of a channel, which can be written-to to fee the channel.") - ($.documentation /.channel + ($.definition /.channel "Creates a brand-new channel and hands it over, along with the sink to write to it." [(channel _)]) - ($.documentation (/.Subscriber it) + ($.definition (/.Subscriber it) "A function that can receive every value fed into a channel.") - ($.documentation /.only + ($.definition /.only (format "Produces a new channel based on the old one, only with values" \n "that pass the test.") [(only pass? channel)]) - ($.documentation /.of_async + ($.definition /.of_async "A one-element channel containing the output from an async." [(of_async async)]) - ($.documentation /.mix + ($.definition /.mix "Asynchronous mix over channels." [(mix f init channel)]) - ($.documentation /.sequential + ($.definition /.sequential "Transforms the given list into a channel with the same elements." [(sequential milli_seconds values)])] [])) diff --git a/stdlib/source/documentation/lux/control/concurrency/semaphore.lux b/stdlib/source/documentation/lux/control/concurrency/semaphore.lux index 77d05a40b..34207f7e5 100644 --- a/stdlib/source/documentation/lux/control/concurrency/semaphore.lux +++ b/stdlib/source/documentation/lux/control/concurrency/semaphore.lux @@ -15,42 +15,42 @@ [($.default /.semaphore_is_maxed_out) ($.default /.barrier) - ($.documentation /.Semaphore + ($.definition /.Semaphore "A tool for controlling access to resources by multiple concurrent processes.") - ($.documentation /.semaphore + ($.definition /.semaphore "" [(semaphore initial_open_positions)]) - ($.documentation /.wait! + ($.definition /.wait! (format "Wait on a semaphore until there are open positions." \n "After finishing your work, you must 'signal' to the semaphore that you're done.") [(wait! semaphore)]) - ($.documentation /.signal! + ($.definition /.signal! "Signal to a semaphore that you're done with your work, and that there is a new open position." [(signal! semaphore)]) - ($.documentation /.Mutex + ($.definition /.Mutex "A mutual-exclusion lock that can only be acquired by one process at a time.") - ($.documentation /.mutex + ($.definition /.mutex "Creates a brand-new mutex." [(mutex _)]) - ($.documentation /.synchronize! + ($.definition /.synchronize! "Runs the procedure with exclusive control of the mutex." [(synchronize! mutex procedure)]) - ($.documentation /.limit + ($.definition /.limit "Produce a limit for a barrier.") - ($.documentation /.Limit + ($.definition /.Limit "A limit for barriers.") - ($.documentation /.Barrier + ($.definition /.Barrier "A barrier that blocks all processes from proceeding until a given number of processes are parked at the barrier.") - ($.documentation /.block! + ($.definition /.block! "Wait on a barrier until all processes have arrived and met the barrier's limit.")] [])) diff --git a/stdlib/source/documentation/lux/control/concurrency/stm.lux b/stdlib/source/documentation/lux/control/concurrency/stm.lux index bd702f964..00bf8fc2c 100644 --- a/stdlib/source/documentation/lux/control/concurrency/stm.lux +++ b/stdlib/source/documentation/lux/control/concurrency/stm.lux @@ -18,25 +18,25 @@ ($.default /.apply) ($.default /.monad) - ($.documentation (/.Var it) + ($.definition (/.Var it) "A mutable cell containing a value, and observers that will be alerted of any change to it.") - ($.documentation /.var + ($.definition /.var "Creates a new STM var, with a default value." [(var value)]) - ($.documentation /.changes + ($.definition /.changes "Creates a channel that will receive all changes to the value of the given var." [(changes target)]) - ($.documentation (/.STM it) + ($.definition (/.STM it) "A computation which updates a transaction and produces a value.") - ($.documentation /.update + ($.definition /.update "Update a var's value, and return a tuple with the old and the new values." [(update function var)]) - ($.documentation /.commit! + ($.definition /.commit! (format "Commits a transaction and returns its result (asynchronously)." \n "Note that a transaction may be re-run an indeterminate number of times if other transactions involving the same variables successfully commit first." \n "For this reason, it's important to note that transactions must be free from side-effects, such as I/O.") diff --git a/stdlib/source/documentation/lux/control/concurrency/thread.lux b/stdlib/source/documentation/lux/control/concurrency/thread.lux index 89e899081..e4ed65586 100644 --- a/stdlib/source/documentation/lux/control/concurrency/thread.lux +++ b/stdlib/source/documentation/lux/control/concurrency/thread.lux @@ -12,10 +12,10 @@ (.List $.Module) ($.module /._ "" - [($.documentation /.parallelism + [($.definition /.parallelism "How many processes can run in parallel.") - ($.documentation /.schedule! + ($.definition /.schedule! "Executes an I/O procedure after some milli-seconds." [(schedule! milli_seconds action)])] [])) |