From f5ea6208e040a9c59824f153c0c8bd11e5efd7c1 Mon Sep 17 00:00:00 2001
From: Corey Richardson <corey@octayn.net>
Date: Sun, 5 Jul 2015 12:18:57 -0400
Subject: [PATCH] collections: vec_deque: add some notes on how to use VecDeque
as a queue effectively
---
src/libcollections/vec_deque.rs | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/src/libcollections/vec_deque.rs b/src/libcollections/vec_deque.rs
index ed47c06e7cd..0f84fc4cc73 100644
--- a/src/libcollections/vec_deque.rs
+++ b/src/libcollections/vec_deque.rs
@@ -38,6 +38,10 @@ const MINIMUM_CAPACITY: usize = 1; // 2 - 1
/// `VecDeque` is a growable ring buffer, which can be used as a
/// double-ended queue efficiently.
+///
+/// The "default" usage of this type as a queue is to use `push_back` to add to the queue, and
+/// `pop_front` to remove from the queue. `extend` and `append` push onto the back in this manner,
+/// and iterating over `VecDeque` goes front to back.
#[stable(feature = "rust1", since = "1.0.0")]
pub struct VecDeque<T> {
// tail and head are pointers into the buffer. Tail always points