From e9e7b9ca971f3003ea8b19b5d733f1ae537a30e4 Mon Sep 17 00:00:00 2001 From: Be Date: Sun, 4 Dec 2022 03:12:20 -0600 Subject: [PATCH] improve Buf wrapper documentation Fixes https://github.com/udoprog/audio/issues/11 --- audio-core/src/buf.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/audio-core/src/buf.rs b/audio-core/src/buf.rs index 22b2fc7..877aeff 100644 --- a/audio-core/src/buf.rs +++ b/audio-core/src/buf.rs @@ -159,7 +159,7 @@ pub trait Buf { /// ``` fn iter(&self) -> Self::Iter<'_>; - /// Construct a new buffer where `n` frames are skipped. + /// Construct a wrapper around this buffer that skips the first `n` frames. /// /// # Examples /// @@ -195,7 +195,7 @@ pub trait Buf { Skip::new(self, n) } - /// Construct a new buffer where `n` frames are skipped. + /// Construct a wrapper around this buffer that skips the last `n` frames. /// /// # Examples /// @@ -239,7 +239,7 @@ pub trait Buf { Tail::new(self, n) } - /// Limit the channel buffer to `limit` number of frames. + /// Construct a wrapper around this buffer which stops after `limit` frames. /// /// # Examples ///