Skip to content

Commit f14e580

Browse files
authored
Auto merge of #34335 - ollie27:docs_collections_mods, r=GuillaumeGomez
Add short summaries to btree modules Also improve hash_map and hash_set module short summaries. These are missing from [here](https://doc.rust-lang.org/nightly/std/collections/#modules). r? @steveklabnik
2 parents d06f1dc + fdeda33 commit f14e580

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/libcollections/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,14 @@ pub mod vec_deque;
105105

106106
#[stable(feature = "rust1", since = "1.0.0")]
107107
pub mod btree_map {
108+
//! A map based on a B-Tree.
108109
#[stable(feature = "rust1", since = "1.0.0")]
109110
pub use btree::map::*;
110111
}
111112

112113
#[stable(feature = "rust1", since = "1.0.0")]
113114
pub mod btree_set {
115+
//! A set based on a B-Tree.
114116
#[stable(feature = "rust1", since = "1.0.0")]
115117
pub use btree::set::*;
116118
}

src/libstd/collections/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -429,14 +429,16 @@ mod hash;
429429

430430
#[stable(feature = "rust1", since = "1.0.0")]
431431
pub mod hash_map {
432-
//! A hashmap
432+
//! A hash map implementation which uses linear probing with Robin
433+
//! Hood bucket stealing.
433434
#[stable(feature = "rust1", since = "1.0.0")]
434435
pub use super::hash::map::*;
435436
}
436437

437438
#[stable(feature = "rust1", since = "1.0.0")]
438439
pub mod hash_set {
439-
//! A hashset
440+
//! An implementation of a hash set using the underlying representation of a
441+
//! HashMap where the value is ().
440442
#[stable(feature = "rust1", since = "1.0.0")]
441443
pub use super::hash::set::*;
442444
}

0 commit comments

Comments
 (0)