Add short summaries to btree modules

Also improve hash_map and hash_set module short summaries.

diff --git a/src/libcollections/lib.rs b/src/libcollections/lib.rs
index 6ab66fc217b46247f57dc548f35b394e63b4f312..b824817d53f1424e5cde49cc804344ab61f8e184 100644 (file)
--- a/src/libcollections/lib.rs
+++ b/src/libcollections/lib.rs
@@ -105,12 +105,14 @@
 
 #[stable(feature = "rust1", since = "1.0.0")]
 pub mod btree_map {
+    //! A map based on a B-Tree.
     #[stable(feature = "rust1", since = "1.0.0")]
     pub use btree::map::*;
 }
 
 #[stable(feature = "rust1", since = "1.0.0")]
 pub mod btree_set {
+    //! A set based on a B-Tree.
     #[stable(feature = "rust1", since = "1.0.0")]
     pub use btree::set::*;
 }

diff --git a/src/libstd/collections/mod.rs b/src/libstd/collections/mod.rs
index 44613d776712f82e5fcc56e60f02912c49cda0ef..9b13d54230078a8de6006c59864c5ee7f54f0143 100644 (file)
--- a/src/libstd/collections/mod.rs
+++ b/src/libstd/collections/mod.rs
@@ -429,14 +429,16 @@
 
 #[stable(feature = "rust1", since = "1.0.0")]
 pub mod hash_map {
-    //! A hashmap
+    //! A hash map implementation which uses linear probing with Robin
+    //! Hood bucket stealing.
     #[stable(feature = "rust1", since = "1.0.0")]
     pub use super::hash::map::*;
 }
 
 #[stable(feature = "rust1", since = "1.0.0")]
 pub mod hash_set {
-    //! A hashset
+    //! An implementation of a hash set using the underlying representation of a
+    //! HashMap where the value is ().
     #[stable(feature = "rust1", since = "1.0.0")]
     pub use super::hash::set::*;
 }