From fdeda33a9a7326ac4979aee5b0c9657298aebe59 Mon Sep 17 00:00:00 2001 From: Oliver Middleton Date: Fri, 17 Jun 2016 23:48:30 +0100 Subject: [PATCH] Add short summaries to btree modules Also improve hash_map and hash_set module short summaries. --- src/libcollections/lib.rs | 2 ++ src/libstd/collections/mod.rs | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/libcollections/lib.rs b/src/libcollections/lib.rs index 6ab66fc217b46..b824817d53f14 100644 --- a/src/libcollections/lib.rs +++ b/src/libcollections/lib.rs @@ -105,12 +105,14 @@ pub mod vec_deque; #[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 44613d776712f..9b13d54230078 100644 --- a/src/libstd/collections/mod.rs +++ b/src/libstd/collections/mod.rs @@ -429,14 +429,16 @@ mod hash; #[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::*; }