Skip to content

Commit e5e799b

Browse files
moving README stuff to doc
1 parent a9f5376 commit e5e799b

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,6 @@ let {
2929
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-heapq.svg?style=flat)](https://github.com/aureooms/js-heapq/issues)
3030
[![Documentation](https://aureooms.github.io/js-heapq/badge.svg)](https://aureooms.github.io/js-heapq/source.html)
3131

32-
## Changes w.r.t. Python's API
33-
34-
```js
35-
let array = [ 2 , 1 , 3 ] ;
36-
let heap = heapq.heapify( compare.increasing , array ) ;
37-
array[0] ; // 1
38-
heapq.heappop( heap ) ; // 1
39-
heapq.heappop( heap ) ; // 2
40-
heapq.heappop( heap ) ; // 3
41-
array.length ; // 0
42-
```
43-
4432
## References
4533

4634
- [Python's heapq library](https://docs.python.org/3.6/library/heapq.html).

doc/manual/example.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
See Python's docs:
22

3-
- [collections](https://docs.python.org/3.6/library/collections.html)
43
- [heapq](https://docs.python.org/3.6/library/heapq.html)
5-
- [bisect](https://docs.python.org/3.6/library/bisect.html)
4+
5+
## Changes w.r.t. Python's API
6+
7+
```js
8+
let array = [ 2 , 1 , 3 ] ;
9+
let heap = heapq.heapify( compare.increasing , array ) ;
10+
array[0] ; // 1
11+
heapq.heappop( heap ) ; // 1
12+
heapq.heappop( heap ) ; // 2
13+
heapq.heappop( heap ) ; // 3
14+
array.length ; // 0
15+
```

0 commit comments

Comments
 (0)