documentation tweaks

Author: RalfJung

library/core/src/ptr/const_ptr.rs

@@ -606,9 +606,8 @@ impl<T: ?Sized> *const T {
     /// Calculates the distance between two pointers. The returned value is in
     /// units of T: the distance in bytes divided by `mem::size_of::<T>()`.
     ///
-    /// This function is the inverse of [`offset`]: it is valid to call if and only if
-    /// `self` could have been computed as `origin.offset(n)` for some `n`, and it will
-    /// then return that `n`.
+    /// This function is the inverse of [`offset`]: it is valid to call and will return
+    /// `n` if and only if `origin.offset(n)` is valid to call and will return `self`.
     ///
     /// [`offset`]: #method.offset
     ///
@@ -649,9 +648,10 @@ impl<T: ?Sized> *const T {
     ///
     /// The requirement for pointers to be derived from the same allocated object is primarily
     /// needed for `const`-compatibility: at compile-time, pointers into *different* allocated
-    /// object do not have a known distance to each other. However, the requirement also exists at
-    /// runtime, and may be exploited by optimizations. You can use `(self as usize).sub(origin as
-    /// usize) / mem::size_of::<T>()` to avoid this requirement.
+    /// objects do not have a known distance to each other. However, the requirement also exists at
+    /// runtime and may be exploited by optimizations. If you wish to compute the difference between
+    /// pointers that are not guaranteed to be from the same allocation, use `(self as
+    /// usize).sub(origin as usize) / mem::size_of::<T>()`.
     ///
     /// [`add`]: #method.add
     /// [allocated object]: crate::ptr#allocated-object

library/core/src/ptr/mut_ptr.rs

@@ -778,9 +778,8 @@ impl<T: ?Sized> *mut T {
     /// Calculates the distance between two pointers. The returned value is in
     /// units of T: the distance in bytes divided by `mem::size_of::<T>()`.
     ///
-    /// This function is the inverse of [`offset`]: it is valid to call if and only if
-    /// `self` could have been computed as `origin.offset(n)` for some `n`, and it will
-    /// then return that `n`.
+    /// This function is the inverse of [`offset`]: it is valid to call and will return
+    /// `n` if and only if `origin.offset(n)` is valid to call and will return `self`.
     ///
     /// [`offset`]: #method.offset-1
     ///
@@ -821,9 +820,10 @@ impl<T: ?Sized> *mut T {
     ///
     /// The requirement for pointers to be derived from the same allocated object is primarily
     /// needed for `const`-compatibility: at compile-time, pointers into *different* allocated
-    /// object do not have a known distance to each other. However, the requirement also exists at
-    /// runtime, and may be exploited by optimizations. You can use `(self as usize).sub(origin as
-    /// usize) / mem::size_of::<T>()` to avoid this requirement.
+    /// objects do not have a known distance to each other. However, the requirement also exists at
+    /// runtime and may be exploited by optimizations. If you wish to compute the difference between
+    /// pointers that are not guaranteed to be from the same allocation, use `(self as
+    /// usize).sub(origin as usize) / mem::size_of::<T>()`.
     ///
     /// [`add`]: #method.add
     /// [allocated object]: crate::ptr#allocated-object