From 61e1b5fdd334fabdc788a5c0a2ab00a08ec8ae7a Mon Sep 17 00:00:00 2001 From: Joohwan Oh Date: Thu, 24 Mar 2022 00:19:52 -0700 Subject: [PATCH] Update introduction message in README.md and docs/index.rst --- README.md | 11 +++++++---- docs/index.rst | 13 ++++++++++--- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 703dce7..98b22d0 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,13 @@ Are you studying binary trees for your next exam, assignment or technical interview? -**Binarytree** is a Python library which lets you generate, visualize, inspect and -manipulate binary trees. Skip the tedious work of setting up test data, and dive -straight into practising your algorithms. Heaps and BSTs (binary search trees) are -also supported. +**Binarytree** is a Python library which lets you generate, visualize, inspect and +manipulate [binary trees](https://en.wikipedia.org/wiki/Binary_tree). Skip the tedious +work of setting up test data, and dive straight into practising your algorithms. +[Heaps](https://en.wikipedia.org/wiki/Heap_(data_structure)) and +[binary search trees](https://en.wikipedia.org/wiki/Binary_search_tree) are also supported. +Self-balancing search trees like [red-black](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) +or [AVL](https://en.wikipedia.org/wiki/AVL_tree) will be added in the future. Check out the [documentation](http://binarytree.readthedocs.io) for more details. diff --git a/docs/index.rst b/docs/index.rst index cf5849b..90335b5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,9 +11,16 @@ Binarytree: Python Library for Studying Binary Trees Welcome to the documentation for **binarytree**. **Binarytree** is Python library which lets you generate, visualize, inspect and -manipulate binary trees. Skip the tedious work of setting up test data, and dive -straight into practising algorithms. Heaps and BSTs (binary search trees) are also -supported. +manipulate `binary trees`_. Skip the tedious work of setting up test data, and dive +straight into practising algorithms. Heaps_ and `binary search trees`_ are also +supported. Self-balancing search trees like `red-black`_ or `AVL`_ will be added in +the future. + +.. _binary trees: https://en.wikipedia.org/wiki/Binary_tree +.. _Heaps: https://en.wikipedia.org/wiki/Heap_(data_structure) +.. _binary search trees: https://en.wikipedia.org/wiki/Binary_search_tree +.. _red-black: https://en.wikipedia.org/wiki/Red%E2%80%93black_tree +.. _AVL: https://en.wikipedia.org/wiki/AVL_tree Requirements ============