FIXUP PTR

Author: Gankra

library/core/src/ptr/const_ptr.rs

@@ -73,6 +73,7 @@ impl<T: ?Sized> *const T {
     where
         T: Sized,
     {
+        // SAFETY: I AM THE MAGIC
         unsafe { core::mem::transmute(self) }
     }
 
@@ -153,7 +154,7 @@ impl<T: ?Sized> *const T {
     /// Here is an example of how to properly use this API to mess around
     /// with tagged pointers. Here we have a tag in the lowest bit:
     ///
-    /// ```ignore
+    /// ```text
     /// let my_tagged_ptr: *const T = ...;
     ///
     /// // Get the address and do whatever bit tricks we like

library/core/src/ptr/mod.rs

@@ -273,7 +273,7 @@ pub const fn null_mut<T>() -> *mut T {
 /// It's sound for an API to use an instance of a ZST to enforce some important
 /// safety property. So for instance, you can make an API like this:
 ///
-/// ```ignore
+/// ```text
 /// pub struct Step1Token(_private_to_construct: ());
 ///
 /// pub fn step1() -> Step1Token { ... }

library/core/src/ptr/mut_ptr.rs

@@ -76,6 +76,7 @@ impl<T: ?Sized> *mut T {
     where
         T: Sized,
     {
+        // SAFETY: I AM THE MAGIC
         unsafe { core::mem::transmute(self) }
     }
 
@@ -156,7 +157,7 @@ impl<T: ?Sized> *mut T {
     /// Here is an example of how to properly use this API to mess around
     /// with tagged pointers. Here we have a tag in the lowest bit:
     ///
-    /// ```ignore
+    /// ```text
     /// let my_tagged_ptr: *mut T = ...;
     ///
     /// // Get the address and do whatever bit tricks we like