From 4fe4e9429a9ad6ec51060c35a382b69651691f8d Mon Sep 17 00:00:00 2001 From: Dan Burkert Date: Sun, 19 Mar 2017 13:53:33 -0700 Subject: Clarify BufMut::advance_mut docs (#78) Also fixes an issue with a line wrap in the middle of an inline code block. --- src/buf/buf_mut.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/buf/buf_mut.rs') diff --git a/src/buf/buf_mut.rs b/src/buf/buf_mut.rs index 8259ccf..848a30a 100644 --- a/src/buf/buf_mut.rs +++ b/src/buf/buf_mut.rs @@ -59,7 +59,7 @@ pub trait BufMut { /// further into the underlying buffer. /// /// This function is unsafe because there is no guarantee that the bytes - /// being advanced to have been initialized. + /// being advanced past have been initialized. /// /// # Examples /// @@ -90,9 +90,9 @@ pub trait BufMut { /// /// # Implementer notes /// - /// It is recommended for implementations of `advance_mut` to panic if `cnt - /// > self.remaining_mut()`. If the implementation does not panic, the call - /// must behave as if `cnt == self.remaining_mut()`. + /// It is recommended for implementations of `advance_mut` to panic if + /// `cnt > self.remaining_mut()`. If the implementation does not panic, + /// the call must behave as if `cnt == self.remaining_mut()`. /// /// A call with `cnt == 0` should never panic and be a no-op. unsafe fn advance_mut(&mut self, cnt: usize); -- cgit v1.2.3