about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2015-12-16 17:46:29 +0530
committerManish Goregaokar <manishsmail@gmail.com>2015-12-16 17:46:29 +0530
commit7aabc66a850004c1b039032ac23be1b43a064bf1 (patch)
tree5fd0b33aa26df3fc4f981d1a1cc84ca60a9dd895
parentd91c34463731ffc4cb74229bc215967b076953be (diff)
parent37b8e22c681a092510e150e5eb5268e749a5a34b (diff)
downloadrust-7aabc66a850004c1b039032ac23be1b43a064bf1.tar.gz
rust-7aabc66a850004c1b039032ac23be1b43a064bf1.zip
Rollup merge of #30376 - salty-horse:btree_links, r=alexcrichton
The BtreeSet main description mentions `BTreeMap`, `Ord`, `Cell`, `RefCell`.

This patch adds links to their documentation.
-rw-r--r--src/libcollections/btree/set.rs11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/libcollections/btree/set.rs b/src/libcollections/btree/set.rs
index a2c09c36795..12d3465e518 100644
--- a/src/libcollections/btree/set.rs
+++ b/src/libcollections/btree/set.rs
@@ -26,12 +26,17 @@ use Bound;
 
 /// A set based on a B-Tree.
 ///
-/// See BTreeMap's documentation for a detailed discussion of this collection's performance
+/// See [`BTreeMap`]'s documentation for a detailed discussion of this collection's performance
 /// benefits and drawbacks.
 ///
 /// It is a logic error for an item to be modified in such a way that the item's ordering relative
-/// to any other item, as determined by the `Ord` trait, changes while it is in the set. This is
-/// normally only possible through `Cell`, `RefCell`, global state, I/O, or unsafe code.
+/// to any other item, as determined by the [`Ord`] trait, changes while it is in the set. This is
+/// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
+///
+/// [`BTreeMap`]: ../struct.BTreeMap.html
+/// [`Ord`]: ../../core/cmp/trait.Ord.html
+/// [`Cell`]: ../../std/cell/struct.Cell.html
+/// [`RefCell`]: ../../std/cell/struct.RefCell.html
 #[derive(Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct BTreeSet<T> {