From 0a795c29a431ff0453eae02596ef9c6fa839054c Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Tue, 17 Feb 2015 13:45:35 -0500 Subject: [PATCH] Clarify RingBuf documentation. FIxes #22361 --- src/libcollections/ring_buf.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/libcollections/ring_buf.rs b/src/libcollections/ring_buf.rs index 0a4ccde923667..e3ab45fca258c 100644 --- a/src/libcollections/ring_buf.rs +++ b/src/libcollections/ring_buf.rs @@ -8,9 +8,11 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -//! This crate implements a double-ended queue with `O(1)` amortized inserts and removals from both -//! ends of the container. It also has `O(1)` indexing like a vector. The contained elements are -//! not required to be copyable, and the queue will be sendable if the contained type is sendable. +//! RingBuf is a double-ended queue, which is implemented with the help of a growing circular buffer. +//! +//! This queue has `O(1)` amortized inserts and removals from both ends of the container. It also +//! has `O(1)` indexing like a vector. The contained elements are not required to be copyable, and +//! the queue will be sendable if the contained type is sendable. #![stable(feature = "rust1", since = "1.0.0")]