Skip to content

Conversation

@rubenperezm
Copy link
Owner

@rubenperezm rubenperezm commented Oct 15, 2024

This pull request includes several updates to the pystrukts library, focusing on enhancing the documentation, adding new data structures, and improving type annotations. The most important changes include restructuring the README.md file, updating pyproject.toml, and adding new data structures and type annotations.

Documentation and Metadata Updates:

  • README.md: Restructured to include installation instructions and categorized data structures into Lists, Trees, Graphs, and Others. [1] [2]
  • pyproject.toml: Updated to include dynamic fields for description, authors, URLs, and keywords. [1] [2]

Type Annotations:

New Data Structures:

rubenperezm and others added 11 commits October 9, 2024 13:16
Create a base class for linked lists, with an abstract method _link defined in the derived classes SinglyLinkedList and DoublyLinkedList
Change from any function to typing.Any
Add section for the pip command and structure the modules by type.
Fetch description, authors, urls and keywords dynamically.
Add generic tree implementation and tests
Add binary tree implementation and tests
Add binary search tree implementation and tests
Remove duplicated lines created when merging main into dev
@rubenperezm rubenperezm self-assigned this Oct 15, 2024
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files with missing lines Coverage Δ
pystrukts/list/doubly_linked_list.py 100.00% <100.00%> (ø)
pystrukts/list/linked_list.py 100.00% <100.00%> (ø)
pystrukts/list/singly_linked_list.py 100.00% <100.00%> (ø)
pystrukts/max_heap.py 100.00% <100.00%> (ø)
pystrukts/tree/__init__.py 100.00% <100.00%> (ø)
pystrukts/tree/binary_search_tree.py 100.00% <100.00%> (ø)
pystrukts/tree/binary_tree.py 100.00% <100.00%> (ø)
pystrukts/tree/generic_tree.py 100.00% <100.00%> (ø)
tests/test_binary_search_tree.py 100.00% <100.00%> (ø)
tests/test_binary_tree.py 100.00% <100.00%> (ø)
... and 1 more

@rubenperezm rubenperezm merged commit 24f1dab into main Oct 15, 2024
6 checks passed
rubenperezm added a commit that referenced this pull request Oct 15, 2024
This reverts commit 24f1dab.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants