about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-12-13 08:22:16 +0000
committerbors <bors@rust-lang.org>2014-12-13 08:22:16 +0000
commitde64f85c6ec8296e68d859a07ea179d3e69eeeb4 (patch)
treebe8a6ff874eac2df1f4c86892c6d3c4f2f79f3e4
parent2d90b91b5d2d18cd433a9e6f1944b685f8b4bb04 (diff)
parent4a46f5ebde5ab6a9a219f8b99eafefb61de2286a (diff)
downloadrust-de64f85c6ec8296e68d859a07ea179d3e69eeeb4.tar.gz
rust-de64f85c6ec8296e68d859a07ea179d3e69eeeb4.zip
auto merge of #19671 : tbu-/rust/pr_doc_removetraitrefs, r=Gankro
This specifically means:
- `Deque`
- `Map`
- `Set`
-rw-r--r--src/libcollections/dlist.rs3
-rw-r--r--src/libcollections/enum_set.rs2
-rw-r--r--src/libcollections/ring_buf.rs2
-rw-r--r--src/libcollections/tree/mod.rs3
-rw-r--r--src/libcollections/tree/set.rs4
-rw-r--r--src/libcollections/trie/mod.rs3
6 files changed, 8 insertions, 9 deletions
diff --git a/src/libcollections/dlist.rs b/src/libcollections/dlist.rs
index b7adaa4227c..d50b212c7dd 100644
--- a/src/libcollections/dlist.rs
+++ b/src/libcollections/dlist.rs
@@ -10,7 +10,8 @@
 
 //! A doubly-linked list with owned nodes.
 //!
-//! The `DList` allows pushing and popping elements at either end.
+//! The `DList` allows pushing and popping elements at either end and is thus
+//! efficiently usable as a double-ended queue.
 
 // DList is constructed like a singly-linked list over the field `next`.
 // including the last link being None; each Node owns its `next` field.
diff --git a/src/libcollections/enum_set.rs b/src/libcollections/enum_set.rs
index 28514b99192..d8dc1f36e05 100644
--- a/src/libcollections/enum_set.rs
+++ b/src/libcollections/enum_set.rs
@@ -20,7 +20,7 @@ use core::num::Int;
 // FIXME(contentions): implement union family of methods? (general design may be wrong here)
 
 #[deriving(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-/// A specialized `Set` implementation to use enum types.
+/// A specialized set implementation to use enum types.
 pub struct EnumSet<E> {
     // We must maintain the invariant that no bits are set
     // for which no variant exists
diff --git a/src/libcollections/ring_buf.rs b/src/libcollections/ring_buf.rs
index 6f396f53940..084b585d7b9 100644
--- a/src/libcollections/ring_buf.rs
+++ b/src/libcollections/ring_buf.rs
@@ -34,7 +34,7 @@ static MINIMUM_CAPACITY: uint = 2u;
 // FIXME(conventions): implement shrink_to_fit. Awkward with the current design, but it should
 // be scrapped anyway. Defer to rewrite?
 
-/// `RingBuf` is a circular buffer.
+/// `RingBuf` is a circular buffer, which can be used as a double-ended queue efficiently.
 pub struct RingBuf<T> {
     // tail and head are pointers into the buffer. Tail always points
     // to the first element that could be read, Head always points
diff --git a/src/libcollections/tree/mod.rs b/src/libcollections/tree/mod.rs
index 20823a2affc..6b185950308 100644
--- a/src/libcollections/tree/mod.rs
+++ b/src/libcollections/tree/mod.rs
@@ -9,8 +9,7 @@
 // except according to those terms.
 
 //! Maps are collections of unique keys with corresponding values, and sets are
-//! just unique keys without a corresponding value. The `Map` and `Set` traits in
-//! `std::container` define the basic interface.
+//! just unique keys without a corresponding value.
 //!
 //! This crate defines the `TreeMap` and `TreeSet` types. Their keys must implement `Ord`.
 //!
diff --git a/src/libcollections/tree/set.rs b/src/libcollections/tree/set.rs
index ea9aff56448..3af2f3e0193 100644
--- a/src/libcollections/tree/set.rs
+++ b/src/libcollections/tree/set.rs
@@ -23,8 +23,8 @@ use tree_map::{TreeMap, Entries, RevEntries, MoveEntries};
 // FIXME(conventions): implement bounded iterators
 // FIXME(conventions): replace rev_iter(_mut) by making iter(_mut) DoubleEnded
 
-/// An implementation of the `Set` trait on top of the `TreeMap` container. The
-/// only requirement is that the type of the elements contained ascribes to the
+/// An implementation of a set on top of the `TreeMap` container. The only
+/// requirement is that the type of the elements contained ascribes to the
 /// `Ord` trait.
 ///
 /// ## Examples
diff --git a/src/libcollections/trie/mod.rs b/src/libcollections/trie/mod.rs
index 9dcb182cd26..4d9191a65b6 100644
--- a/src/libcollections/trie/mod.rs
+++ b/src/libcollections/trie/mod.rs
@@ -9,8 +9,7 @@
 // except according to those terms.
 
 //! Maps are collections of unique keys with corresponding values, and sets are
-//! just unique keys without a corresponding value. The `Map` and `Set` traits in
-//! `std::container` define the basic interface.
+//! just unique keys without a corresponding value.
 //!
 //! This crate defines `TrieMap` and `TrieSet`, which require `uint` keys.
 //!