Add a safety section for RawBitFlags

Shut up clippy
meithecatte · Mar 24, 2022 · e1c8b64 · e1c8b64
1 parent 0c70b0f
commit e1c8b64
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -188,6 +188,11 @@ pub trait BitFlag: Copy + Clone + 'static + _internal::RawBitFlags {
 pub mod _internal {
     /// A trait automatically implemented by `#[bitflags]` to make the enum
     /// a valid type parameter for `BitFlags<T>`.
+    ///
+    /// # Safety
+    ///
+    /// The values should reflect reality, like they do if the implementation
+    /// is generated by the procmacro.
     pub unsafe trait RawBitFlags: Copy + Clone + 'static {
         /// The underlying integer type.
         type Numeric: BitFlagNum;