Document non-trivial function Code.constant_equal

Co-authored-by: Jérome Vouillon <[email protected]>
ocsigen · Jul 31, 2024 · 3ed6c34 · 3ed6c34
1 parent 3204c33
commit 3ed6c34
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/compiler/lib/code.mli b/compiler/lib/code.mli
@@ -185,6 +185,9 @@ type constant =
   | Tuple of int * constant array * array_or_not
   | Int of int32
 
+(** Guaranteed equality in terms of both OCaml [(=)] and Javascript [(==)]: if
+    [constant_equal a b = Some v], then [Poly.(=) a b = v] and
+    [Js_of_ocaml.Js.equals a b = v]. This is used for optimization purposes. *)
 val constant_equal : constant -> constant -> bool option
 
 type loc =