Skip to content

Commit

Permalink
Use check mark on green background in design document
Browse files Browse the repository at this point in the history
  • Loading branch information
pnevyk committed Aug 7, 2024
1 parent b4f8163 commit 5755449
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ _Offer simplicity as well as flexibility and strive for a good balance if in
conflict. Do not close the door on potential extensions. Unleash the fantasies
about all possible use cases and environments that we can support._

### Correctness :heavy_check_mark:
### Correctness :white_check_mark:

_Use extensive fuzzing and property-based testing to increase confidence about
correctness, because unit tests are not enough. Unsafe code is only the last
Expand Down Expand Up @@ -93,7 +93,7 @@ enforcing an algorithm might be needed are these:
* The specific algorithm provides an output that has richer API than the common
entrypoint (which provides as much as each and every available algorithm can).

Regarding _correctness_ ( :heavy_check_mark: ), it is mainly about avoiding
Regarding _correctness_ ( :white_check_mark: ), it is mainly about avoiding
misuse by the user. Automatic selection makes sure to choose an algorithm that
is supposed to work correctly on the graph given known properties (for example,
negative weights aware algorithm when weights are not guaranteed to be positive
Expand Down Expand Up @@ -283,7 +283,7 @@ Graphs are complicated data structures, especially if the implementation strives
to be efficient, and algorithms on them can be very complex with many corner
cases. For that reason, a high level of confidence in _correctness_ cannot be
achieved by using just unit tests. Instead, gryf heavily utilizes fuzzing and
property-based testing ( :heavy_check_mark: ).
property-based testing ( :white_check_mark: ).

There are two main areas for these testing techniques: _graph storages_ and
_algorithms_. These two require a little bit different approaches.
Expand Down

0 comments on commit 5755449

Please sign in to comment.