Skip to content

Commit 899fc93

Browse files
committed
DOC: Add a doc section drawing attention to some extra features
1 parent aef602a commit 899fc93

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/lib.rs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,19 @@
1212
//! [`IndexSet`]: set/struct.IndexSet.html
1313
//!
1414
//!
15+
//! ### Feature Highlights
1516
//!
16-
//! ## Rust Version
17+
//! [`IndexMap`] and [`IndexSet`] are drop-in compatible with the std `HashMap`
18+
//! and `HashSet`, but they also have some features of note:
19+
//!
20+
//! - The ordering semantics (see their documentation for details)
21+
//! - Sorting methods and the [`.pop()`][IndexMap::pop] methods.
22+
//! - The [`Equivalent`] trait, which offers more flexible equality definitions
23+
//! between borrowed and owned versions of keys.
24+
//! - The [`MutableKeys`][map::MutableKeys] trait, which gives opt-in mutable
25+
//! access to hash map keys.
26+
//!
27+
//! ### Rust Version
1728
//!
1829
//! This version of indexmap requires Rust 1.18 or later, or 1.30+ for
1930
//! development builds, and Rust 1.36+ for using with `alloc` (without `std`),

0 commit comments

Comments
 (0)