Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error Modeling and Unit Testing for Modules #3

Merged
merged 12 commits into from
Mar 4, 2024
Merged

Conversation

christopherkeim
Copy link
Owner

Description

These changes collectively implement error modeling with enums and unit tests for the hmtl, markdown, and files modules.

Motivation and Context

This adds error modeling and unit testing examples to the template.

Testing

Unit tests are included in each module within a tests submodule.

This template does not implement integration testing, which is idiomatically included in a tests directory at the same level as src.

Dependencies Added:

Development Dependencies

  • tempfile = "3.10.1"

Dependencies Removed:

None

Types of changes

  • Documentation (non-breaking change which improves documentation)
  • Refactoring / Cleanup (non-breaking change which does not add functionality or fix issues)

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly (or no changes needed).
  • I have added tests to cover my changes (or no new test are needed).
  • All new and existing tests are passing.

@christopherkeim christopherkeim added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 4, 2024
@christopherkeim christopherkeim self-assigned this Mar 4, 2024
@christopherkeim christopherkeim merged commit a77a0fe into main Mar 4, 2024
1 check passed
@christopherkeim christopherkeim deleted the chris/add-tests branch March 4, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant