Skip to content

Commit af41f44

Browse files
committed
docs: Update README
1 parent 8bce1cc commit af41f44

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ heap vs array: push + top(50) of 100
4040

4141
### 2.0.x
4242

43-
The main breaking change is that now _`top(N)` does NOT sort the output_. It should not be part of the spec for a priority queue, the output should be the top N elements. It will be _partially ordered_ by definition, that is all.
43+
The main breaking change is that now _`top(N)` does NOT sort the output_. It should not be part of the spec for a priority queue, the output should be the top N elements. It will be _partially ordered_ with the peek at index `0` by definition, that is all.
4444

4545
- `top(N)` is unordered, only the first element is guaranteed to be the top priority element.
4646
- Fixes custom heap issue [#31](https://github.com/ignlg/heap-js/issues/31).
4747
- Performance improvements.
48-
- More tests, even for custom heaps.
48+
- More tests, including those for custom heaps.
4949
- Auxiliary experimental topN algorithms.
5050
- (wip) Benchmarks.
5151

0 commit comments

Comments
 (0)