Document usage of 's second argument.

Signed-off-by: Carl Eastlund <[email protected]>
ocaml-ppx · Feb 12, 2025 · fb608b4 · fb608b4
1 parent 03cf083
commit fb608b4
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/ast_pattern.mli b/src/ast_pattern.mli
@@ -212,4 +212,5 @@ val of_func : (context -> Location.t -> 'a -> 'b -> 'c) -> ('a, 'b, 'c) t
 val to_func : ('a, 'b, 'c) t -> context -> Location.t -> 'a -> 'b -> 'c
 
 val fail : Location.t -> string -> _
-(** Call from [of_func]'s argument when the pattern does not match. *)
+(** Call from [of_func]'s argument when the pattern does not match. The string
+    should describe the expected shape of the AST where the match failed. *)