aboutsummaryrefslogtreecommitdiff
path: root/lib/kernel/celebration.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/kernel/celebration.mli')
-rw-r--r--lib/kernel/celebration.mli16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/kernel/celebration.mli b/lib/kernel/celebration.mli
new file mode 100644
index 0000000..1c84d35
--- /dev/null
+++ b/lib/kernel/celebration.mli
@@ -0,0 +1,16 @@
+(** A celebration. Parameterised by the rite's rank type only. *)
+type 'r t = {
+ slug : Slug.t;
+ names : Names.t;
+ rank : 'r;
+ colour : Colour.t;
+ subject : Subject.t;
+ citations : Citation.t list;
+ layer : string;
+}
+[@@deriving sexp]
+
+(** [subject] defaults to [Subject.Temporal], [names] to empty, [citations] to []. *)
+val make :
+ slug:Slug.t -> ?names:Names.t -> rank:'r -> colour:Colour.t ->
+ ?subject:Subject.t -> ?citations:Citation.t list -> layer:string -> unit -> 'r t