Skip to content

[WIP] Add docs and tests - #6

Merged
espottesmith merged 72 commits into
mainfrom
docs_and_tests
Sep 22, 2025
Merged

espottesmith merged 72 commits into
mainfrom
docs_and_tests

Conversation

@espottesmith

Copy link
Copy Markdown
Member

Description

Thanks to @punnaamorn's work, we now have the beginnings of a test suite. This PR will attempt to expand this, aiming for near-perfect test coverage. A goal of this PR is also to improve documentation. This is an important step towards an initial v0.1 release.

Change features

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have run tests locally, and all tests passed
  • My changes generate no (new) warnings

@espottesmith espottesmith added the wip Work in progress label Aug 14, 2025
@espottesmith
espottesmith merged commit a9c7f77 into main Sep 22, 2025
3 checks passed
@espottesmith espottesmith mentioned this pull request Sep 24, 2025
7 of 12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

wip Work in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants