Add note about mrb_protect_error

artichoke · Jun 28, 2022 · f0019ad · f0019ad
1 parent 458747f
commit f0019ad
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/artichoke-backend/src/raise.rs b/artichoke-backend/src/raise.rs
@@ -38,6 +38,13 @@ unsafe extern "C-unwind" fn exc_throw(mrb: *mut sys::mrb_state, exc: sys::mrb_va
     }));
 }
 
+// ```c
+// typedef mrb_value mrb_protect_error_func(mrb_state *mrb, void *userdata);
+// MRB_API mrb_value mrb_protect_error(mrb_state *mrb, mrb_protect_error_func *body, void *userdata, mrb_bool *error);
+// ```
+//
+// NOTE: This remains implemented in mruby in `vm.c`.
+
 // ```c
 // MRB_API mrb_value
 // mrb_protect(mrb_state *mrb, mrb_func_t body, mrb_value data, mrb_bool *state)