Skip to content

Commit de64f85

Browse files
committed
auto merge of #19671 : tbu-/rust/pr_doc_removetraitrefs, r=Gankro
This specifically means: - `Deque` - `Map` - `Set`
2 parents 2d90b91 + 4a46f5e commit de64f85

File tree

6 files changed

+8
-9
lines changed

6 files changed

+8
-9
lines changed

src/libcollections/dlist.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010

1111
//! A doubly-linked list with owned nodes.
1212
//!
13-
//! The `DList` allows pushing and popping elements at either end.
13+
//! The `DList` allows pushing and popping elements at either end and is thus
14+
//! efficiently usable as a double-ended queue.
1415
1516
// DList is constructed like a singly-linked list over the field `next`.
1617
// including the last link being None; each Node owns its `next` field.

src/libcollections/enum_set.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ use core::num::Int;
2020
// FIXME(contentions): implement union family of methods? (general design may be wrong here)
2121

2222
#[deriving(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
23-
/// A specialized `Set` implementation to use enum types.
23+
/// A specialized set implementation to use enum types.
2424
pub struct EnumSet<E> {
2525
// We must maintain the invariant that no bits are set
2626
// for which no variant exists

src/libcollections/ring_buf.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ static MINIMUM_CAPACITY: uint = 2u;
3434
// FIXME(conventions): implement shrink_to_fit. Awkward with the current design, but it should
3535
// be scrapped anyway. Defer to rewrite?
3636

37-
/// `RingBuf` is a circular buffer.
37+
/// `RingBuf` is a circular buffer, which can be used as a double-ended queue efficiently.
3838
pub struct RingBuf<T> {
3939
// tail and head are pointers into the buffer. Tail always points
4040
// to the first element that could be read, Head always points

src/libcollections/tree/mod.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
// except according to those terms.
1010

1111
//! Maps are collections of unique keys with corresponding values, and sets are
12-
//! just unique keys without a corresponding value. The `Map` and `Set` traits in
13-
//! `std::container` define the basic interface.
12+
//! just unique keys without a corresponding value.
1413
//!
1514
//! This crate defines the `TreeMap` and `TreeSet` types. Their keys must implement `Ord`.
1615
//!

src/libcollections/tree/set.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ use tree_map::{TreeMap, Entries, RevEntries, MoveEntries};
2323
// FIXME(conventions): implement bounded iterators
2424
// FIXME(conventions): replace rev_iter(_mut) by making iter(_mut) DoubleEnded
2525

26-
/// An implementation of the `Set` trait on top of the `TreeMap` container. The
27-
/// only requirement is that the type of the elements contained ascribes to the
26+
/// An implementation of a set on top of the `TreeMap` container. The only
27+
/// requirement is that the type of the elements contained ascribes to the
2828
/// `Ord` trait.
2929
///
3030
/// ## Examples

src/libcollections/trie/mod.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99
// except according to those terms.
1010

1111
//! Maps are collections of unique keys with corresponding values, and sets are
12-
//! just unique keys without a corresponding value. The `Map` and `Set` traits in
13-
//! `std::container` define the basic interface.
12+
//! just unique keys without a corresponding value.
1413
//!
1514
//! This crate defines `TrieMap` and `TrieSet`, which require `uint` keys.
1615
//!

0 commit comments

Comments
 (0)