Skip to content

Commit

Permalink
Add a comment that explains the intended meaning of [never_raises]
Browse files Browse the repository at this point in the history
never lets exceptions escape
  • Loading branch information
gretay-js committed May 7, 2024
1 parent 6519885 commit 67c2691
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ocaml/parsing/builtin_attributes.mli
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,10 @@ type check_attribute =
strict: bool;
never_returns_normally: bool;
never_raises: bool;
(* [never_raises=true] the function never returns
via an exception. The function (directly or transitively)
may raise exceptions that do not escape, i.e.,
handled before the function returns. *)
arity: int;
loc: Location.t;
}
Expand Down

0 comments on commit 67c2691

Please sign in to comment.