Skip to content

Commit

Permalink
chore: Boast about test suite (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
antonagestam authored Feb 27, 2024
1 parent 17f6516 commit 44c25c0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,19 @@ $ pip install --require-venv immoney

### Design goals

There are a few core design aspects of this library that each eliminate entire classes
of bugs:
These core aspects of this library each eliminate entire classes of bugs:

- Exposed and internal data types are either immutable or faux immutable.
- Invalid amounts of money cannot be represented. There is no such thing as `0.001` US
dollars, and there is no such thing as negative money.
- Builtin operations never implicitly lose precision.
- Built from the ground-up with support for static type checking in mind. This means
that bugs that attempt to mix currencies can be found by a static type checker.
- A comprehensive test suite with 100% coverage, including property tests that assert
random [sequences of operations][sequence-test] behave as expected.

[sequence-test]:
https://github.com/antonagestam/immoney/blob/cc8ad48713fcf5c843e9832de9f722366b17a404/tests/test_arithmetic.py#L190

### Features

Expand Down

0 comments on commit 44c25c0

Please sign in to comment.