Skip to content

Commit

Permalink
Change assert_unsafe_precondition docs to refer to check_language_ub
Browse files Browse the repository at this point in the history
  • Loading branch information
ChaiTRex committed Aug 21, 2024
1 parent 7f8bdd5 commit 9d2bb97
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion core/src/ub_checks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::intrinsics::{self, const_eval_select};
/// macro for language UB are always ignored.
///
/// This macro should be called as
/// `assert_unsafe_precondition!(check_{library,lang}_ub, "message", (ident: type = expr, ident: type = expr) => check_expr)`
/// `assert_unsafe_precondition!(check_{library,language}_ub, "message", (ident: type = expr, ident: type = expr) => check_expr)`
/// where each `expr` will be evaluated and passed in as function argument `ident: type`. Then all
/// those arguments are passed to a function with the body `check_expr`.
/// Pick `check_language_ub` when this is guarding a violation of language UB, i.e., immediate UB
Expand Down

0 comments on commit 9d2bb97

Please sign in to comment.