Change assert_unsafe_precondition docs to refer to check_language_ub · patricklam/verify-rust-std@9d2bb97 (original) (raw)

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ use crate::intrinsics::{self, const_eval_select};
10 10 /// macro for language UB are always ignored.
11 11 ///
12 12 /// This macro should be called as
13 -/// `assert_unsafe_precondition!(check_{library,lang}_ub, "message", (ident: type = expr, ident: type = expr) => check_expr)`
13 +/// `assert_unsafe_precondition!(check_{library,language}_ub, "message", (ident: type = expr, ident: type = expr) => check_expr)`
14 14 /// where each `expr` will be evaluated and passed in as function argument `ident: type`. Then all
15 15 /// those arguments are passed to a function with the body `check_expr`.
16 16 /// Pick `check_language_ub` when this is guarding a violation of language UB, i.e., immediate UB