about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-02-17 13:45:35 -0500
committerSteve Klabnik <steve@steveklabnik.com>2015-02-17 13:45:35 -0500
commit0a795c29a431ff0453eae02596ef9c6fa839054c (patch)
tree38dba902e01e9d5e879b16cb3187563931a056f9
parentf1bb6c2f46f08c1d7b6d695f5b3cf93142cb8860 (diff)
Clarify RingBuf documentation.
FIxes #22361
-rw-r--r--src/libcollections/ring_buf.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/libcollections/ring_buf.rs b/src/libcollections/ring_buf.rs
index 0a4ccde9236..e3ab45fca25 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")]