add comment about the captured backtrace

ahrefs · Sep 19, 2024 · f771f08 · f771f08
1 parent 668c5d8
commit f771f08
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/exn.ml b/exn.ml
@@ -32,6 +32,11 @@ let to_string exn =
 
 let str = to_string
 
+(**
+  The original backtrace is captured via `Printexc.get_raw_backtrace ()`.
+  However, note that this backtrace might not correspond to the provided `exn`
+  if another exception was raised before `fail` is called.
+*)
 let fail ?exn fmt =
   let fails s =
     match exn with