From a313918e745af9c0969c595a8e836db5df1d4527 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 19 Sep 2022 21:49:47 -0400 Subject: [PATCH] doc --- src/util/Event.mli | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/util/Event.mli b/src/util/Event.mli index c720405a..00f87d34 100644 --- a/src/util/Event.mli +++ b/src/util/Event.mli @@ -1,3 +1,10 @@ +(** Event pattern. + + This provides a basic observer pattern, where events are emitted + from some source (with an attached value), and callbacks that were + registered will receive this value. +*) + type ('a, 'b) t (** An event emitting values of type ['a], where subscribers return values of type ['b]. *)