Skip to content

Commit

Permalink
docs: added documentation reference in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
warmachine028 committed Aug 3, 2023
1 parent a398c3b commit ebdc36b
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,29 @@

## What's New?

- Refactored Array Contents
- Added AbstractArray SubModule to abstract print logic
- Added more test cases for Queues
- Type Checked Arrays and Lists with mypy
- Refactored Trees
- Added Nodes SubPackage
- Separated TreeNodes into Nodes
- Added Tables SubPackage
- Added Colors and ColorCodes in Utils
- Refactored Lists
- Removed `__repr__` overrides
- Added Exceptions in Utils
- Added Warnings in Utils
- Added new workflows
- Added datastax.Wiki

## Table of Contents

- [What's New](#whats-new)
- [Introduction](#introduction)
- [Problem Statement](#problem-statement)
- [Benefits](#benefits)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [What's Next](#whats-next)
- [Documentation](#documentation)
- [License](#license)

## Introduction

Expand Down Expand Up @@ -195,9 +204,17 @@ pip install datastax

![rbt_output](https://github.com/warmachine028/datastax/assets/75939390/3af4ceb6-1e68-4906-ba39-db84dbf274f0)

## What's Next
## Documentation

- Enhanced Documentation
- Better TestCases for Huffman Tree
- Better TestCases for Segment Trees
- Test Cases for Fibonacci Tree
- For detailed documentation. See [documentation](https://github.com/warmachine028/datastax/wiki)
- (Still in progress)

## License

- see [LICENSE]

**Pritam, 2023**

[license]: https://github.com/warmachine028/datastax/blob/main/LICENSE

---------------------------------------------------
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
with codecs.open("README.md", 'r', errors='ignore', encoding='utf8') as f:
readme_contents = f.read()

except Exception as error:
except FileNotFoundError as e:
readme_contents = (
'This library which supports ADTs like Arrays, LinkedLists and Trees '
'and its types. This instant library is solely written from scratch '
Expand Down Expand Up @@ -59,7 +59,7 @@
'5. Tables\n'
' a. HuffmanTable'
)
sys.stderr.write(f"Warning: Could not open README.md due {error}\n")
sys.stderr.write(f"Warning: Could not open README.md due {e}\n")
setup(
name='datastax',
maintainer="Pritam Kundu",
Expand Down

0 comments on commit ebdc36b

Please sign in to comment.