Make `ptr::eq` documentation mention smart-pointer behavior

Resolves #59214

diff --git a/src/libcore/ptr.rs b/src/libcore/ptr.rs
index a9a029d606d6f84315931b1b69381dfe663c1de4..c9f1a87ba9ff21efef6a6bab082ee73044208df3 100644 (file)
--- a/src/libcore/ptr.rs
+++ b/src/libcore/ptr.rs
@@ -2483,6 +2483,10 @@ impl<T: ?Sized> Eq for *mut T {}
 /// by their address rather than comparing the values they point to
 /// (which is what the `PartialEq for &T` implementation does).
 ///
+/// Smart pointer types, such as `Box`, `Rc`, and `Arc` do not compare
+/// using this function, instead they compare the values rather than
+/// their addresses.
+///
 /// # Examples
 ///
 /// ```