add docs for is_safe

carolynzech · Sep 19, 2024 · 51a0cbc · 51a0cbc
1 parent 20696bf
commit 51a0cbc
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/library/core/src/ub_checks.rs b/library/core/src/ub_checks.rs
@@ -226,5 +226,6 @@ mod predicates {
 /// Therefore, validity invariants must be upheld at all times, while safety
 /// invariants only need to be upheld at the boundaries to safe code.
 pub trait Invariant {
+ /// Specify the type's safety invariants 
  fn is_safe(&self) -> bool;
 }