# HG changeset patch # User Malcolm Matalka # Date 1566745206 -7200 # Sun Aug 25 17:00:06 2019 +0200 # Node ID b19dcaef25ca9341eb6e1f1bc0b944a385d4cdf8 # Parent c8268a144f1ba8cb13ad03cc30bcb00e3f6bb4f6 ADD js_of_ocaml-ppx to build script diff --git a/.builds/alpine.yml b/.builds/alpine.yml --- a/.builds/alpine.yml +++ b/.builds/alpine.yml @@ -17,7 +17,7 @@ opam switch create 4.06.0 - setup-environment: | eval $(opam env) - opam install -y hll pds js_of_ocaml + opam install -y hll pds js_of_ocaml js_of_ocaml-ppx - build: | eval $(opam env) cd byocm/code diff --git a/.builds/freebsd.yml b/.builds/freebsd.yml --- a/.builds/freebsd.yml +++ b/.builds/freebsd.yml @@ -16,7 +16,7 @@ opam switch create 4.06.0 - setup-environment: | eval $(opam env) - opam install -y hll pds js_of_ocaml + opam install -y hll pds js_of_ocaml js_of_ocaml-ppx - build: | eval $(opam env) cd byocm/code diff --git a/code/src/byocm_fut/byocm_fut.mli b/code/src/byocm_fut/byocm_fut.mli --- a/code/src/byocm_fut/byocm_fut.mli +++ b/code/src/byocm_fut/byocm_fut.mli @@ -1,3 +1,17 @@ +(** This module provides a basic promise/future implementation with an infix + monadic implementation. + + A promise is a container for a value which will be set at some point in the + future. A promise can only be set once. A future is a value which is used + to wait for the value of a promise to be set. A future is read-only while a + promise is write-only. + + An API will generally be written like: + + [ let p = Promise.create () in + let callback v = Promise.set p v in + schedule_work callback; + Promise.future p ] *) type +'a t module Promise : sig