diff options
| -rw-r--r-- | src/libstd/ptr.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/ptr.rs b/src/libstd/ptr.rs index 037984d9e7f..193e9ea7052 100644 --- a/src/libstd/ptr.rs +++ b/src/libstd/ptr.rs @@ -213,7 +213,8 @@ pub trait RawPtr<T> { /// be pointing to invalid memory. unsafe fn to_option(&self) -> Option<&T>; /// Calculates the offset from a pointer. The offset *must* be in-bounds of - /// the object, or one-byte-past-the-end. + /// the object, or one-byte-past-the-end. `count` is in units of T; e.g. a + /// `count` of 3 represents a pointer offset of `3 * sizeof::<T>()` bytes. unsafe fn offset(self, count: int) -> Self; } |