Update library/core/src/primitive_docs.rs

Co-authored-by: Ralf Jung <post@ralfj.de>
joshlf · Oct 13, 2023 · 39660c4 · 39660c4
1 parent 4f0192a
commit 39660c4
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/library/core/src/primitive_docs.rs b/library/core/src/primitive_docs.rs
@@ -1397,7 +1397,11 @@ mod prim_usize {}
 /// which violates any of these properties.
 ///
 /// * `t` is aligned to `align_of_val(t)`
-/// * `t` refers to a single [allocated object]
+/// * `t` is dereferenceable for `size_of_val(t)` many bytes
+///
+///  Being "dereferenceable" for N bytes means that the memory range beginning
+/// at the address `t` points to and ending N bytes later is all contained within a
+/// single [allocated object].
 ///
 /// [allocated object]: ptr#allocated-object
 #[stable(feature = "rust1", since = "1.0.0")]