Skip to content

Commit 722ec58

Browse files
committed
Update CHANGELOG.md and document compatibility
1 parent ae09fe7 commit 722ec58

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
### Added
10+
11+
* `#[must_use]` attribute to many methods, porting and extending several
12+
rust-lang/rust PRs
13+
* Method `shrink_to()` for Rust 1.56.0 and greater, ported from rust-lang/rust
14+
* Implementation of `From<BinaryHeap<T, C>>` for `Vec<T>` for Rust 1.41.0 or
15+
greater
16+
* Implementation of `From<[T; N]>` for `BinaryHeap<T>` for Rust 1.56.0 or
17+
greater, ported from rust-lang/rust#84111
18+
* Links to referenced items in the documenation
19+
* Example of a min-heap, ported from rust-lang/rust#60451
20+
* Documentation of time complexities of several methods, ported from
21+
rust-lang/rust#60952
22+
923
### Changed
1024

1125
* Bump MSRV (minimum supported rust version) to rust 1.36.0.
26+
* Port rust-lang/rust#77435 improvement to rebuild heuristic of
27+
`BinaryHeap::append()`
28+
* Use italics with big-O notation in documentation, ported from
29+
rust-lang/rust#71167
30+
* Relax trait bound `C: Compare<T>` on `BinaryHeap<T, C>` struct and certain
31+
methods, in part ported from rust-lang/rust#58421
32+
* Synchronize internal implementation details with
33+
`std::collections::BinaryHeap` in Rust 1.62.0
1234

1335
## [0.4.1] - 2021-01-06
1436

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,15 @@ Other notable added methods are:
2020
- `.into_iter_sorted()` which is less-surprising version of `.into_iter()`. The implementation is backported from `std`.
2121
- `.replace_cmp()` which replace the comparator of the existing heap.
2222

23-
## MSRV (Minimum Supported Rust Version)
23+
## Compatibility and MSRV (Minimum Supported Rust Version)
2424

25-
This crate requires Rust 1.36.0 or later.
25+
This crate is based on the standard library's implementation of
26+
[`BinaryHeap`](https://doc.rust-lang.org/stable/std/collections/struct.BinaryHeap.html)
27+
from Rust 1.62.0.
28+
29+
This crate requires Rust 1.36.0 or later. A few of its APIs are only available
30+
for more recent versions of Rust where they have been stabilized in the
31+
standard library; see the documentation for specifics.
2632

2733
# Changes
2834

0 commit comments

Comments
 (0)