Skip to content

Commit

Permalink
Add docstring to main module
Browse files Browse the repository at this point in the history
  • Loading branch information
Seelengrab committed Mar 18, 2024
1 parent 87b22a1 commit 7d2fd76
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/Supposition.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
"""
Supposition.jl
Supposition.jl is a fuzzing & property based testing (PBT) framework,
integrating nicely with `Test.@testset`. Under the hood it's similar
to the Python fuzzing framework Hypothesis.
The package features:
* Generation of (almost) arbitrary instances of types
* Minimization of failure cases
* Testing of statemachines
* Deterministic replaying of failures cases
..and a bunch more! Please check out [the documentation](https://seelengrab.github.io/Supposition.jl/stable/) for more information.
"""
module Supposition

export assume!, target!, reject, example
Expand Down

0 comments on commit 7d2fd76

Please sign in to comment.