Skip to content

Commit 61e1b5f

Browse files
committed
Update introduction message in README.md and docs/index.rst
1 parent fddb6bb commit 61e1b5f

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@
99

1010
Are you studying binary trees for your next exam, assignment or technical interview?
1111

12-
**Binarytree** is a Python library which lets you generate, visualize, inspect and
13-
manipulate binary trees. Skip the tedious work of setting up test data, and dive
14-
straight into practising your algorithms. Heaps and BSTs (binary search trees) are
15-
also supported.
12+
**Binarytree** is a Python library which lets you generate, visualize, inspect and
13+
manipulate [binary trees](https://en.wikipedia.org/wiki/Binary_tree). Skip the tedious
14+
work of setting up test data, and dive straight into practising your algorithms.
15+
[Heaps](https://en.wikipedia.org/wiki/Heap_(data_structure)) and
16+
[binary search trees](https://en.wikipedia.org/wiki/Binary_search_tree) are also supported.
17+
Self-balancing search trees like [red-black](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree)
18+
or [AVL](https://en.wikipedia.org/wiki/AVL_tree) will be added in the future.
1619

1720
Check out the [documentation](http://binarytree.readthedocs.io) for more details.
1821

docs/index.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,16 @@ Binarytree: Python Library for Studying Binary Trees
1111
Welcome to the documentation for **binarytree**.
1212

1313
**Binarytree** is Python library which lets you generate, visualize, inspect and
14-
manipulate binary trees. Skip the tedious work of setting up test data, and dive
15-
straight into practising algorithms. Heaps and BSTs (binary search trees) are also
16-
supported.
14+
manipulate `binary trees`_. Skip the tedious work of setting up test data, and dive
15+
straight into practising algorithms. Heaps_ and `binary search trees`_ are also
16+
supported. Self-balancing search trees like `red-black`_ or `AVL`_ will be added in
17+
the future.
18+
19+
.. _binary trees: https://en.wikipedia.org/wiki/Binary_tree
20+
.. _Heaps: https://en.wikipedia.org/wiki/Heap_(data_structure)
21+
.. _binary search trees: https://en.wikipedia.org/wiki/Binary_search_tree
22+
.. _red-black: https://en.wikipedia.org/wiki/Red%E2%80%93black_tree
23+
.. _AVL: https://en.wikipedia.org/wiki/AVL_tree
1724

1825
Requirements
1926
============

0 commit comments

Comments
 (0)