diff --git a/src/libstd/ptr.rs b/src/libstd/ptr.rs index 037984d9e7fc7..193e9ea7052f0 100644 --- a/src/libstd/ptr.rs +++ b/src/libstd/ptr.rs @@ -213,7 +213,8 @@ pub trait RawPtr { /// 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::()` bytes. unsafe fn offset(self, count: int) -> Self; }