indexmap 1.0.0

Closes rust-lang#37

Cargo.toml

@@ -8,7 +8,18 @@ authors = [
 documentation = "https://docs.rs/indexmap/"
 repository = "https://github.com/bluss/indexmap"
 license = "Apache-2.0/MIT"
-description = "A hash table with consistent order and fast iteration."
+description = """
+A hash table with consistent order and fast iteration.
+
+The indexmap is a hash table where the iteration order of the key-value
+pairs is independent of the hash values of the keys. It has the usual
+hash table functionality, it preserves insertion order except after
+removals, and it allows lookup of its elements by either hash table key
+or numerical index. A corresponding hash set type is also provided.
+
+This crate was initially published under the name ordermap, but it was renamed to
+indexmap.
+"""
 
 keywords = ["hashmap"]
 categories = ["data-structures"]

README.rst

@@ -103,6 +103,17 @@ Ideas that we already did
 Recent Changes
 ==============
 
+- 1.0.0
+
+  - This is the 1.0 release for ``indexmap``! (the crate and datastructure
+    formerly known as “ordermap”)
+  - ``OccupiedEntry::insert`` changed its signature, to use ``&mut self`` for
+    the method receiver, matching the equivalent method for a standard
+    ``HashMap``.  Thanks to @dtolnay for finding this bug.
+  - The deprecated old names from ordermap were removed: ``OrderMap``,
+    ``OrderSet``, ``ordermap!{}``, ``orderset!{}``. Use the new ``IndexMap``
+    etc names instead.
+
 - 0.4.1
 
   - Renamed crate to ``indexmap``; the ``ordermap`` crate is now deprecated

src/lib.rs

@@ -1,6 +1,6 @@
 
 #![deny(unsafe_code)]
-#![doc(html_root_url = "https://docs.rs/indexmap/0.4/")]
+#![doc(html_root_url = "https://docs.rs/indexmap/1/")]
 
 //! [`IndexMap`] is a hash table where the iteration order of the key-value
 //! pairs is independent of the hash values of the keys.