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

Usage documentation #108

Open
moodmosaic opened this issue Jan 31, 2025 · 0 comments · May be fixed by #117
Open

Usage documentation #108

moodmosaic opened this issue Jan 31, 2025 · 0 comments · May be fixed by #117
Labels
documentation Improvements or additions to documentation

Comments

@moodmosaic
Copy link
Member

We should document the basic usage scenarios of rv. This should include:

  • Difference between a stateless test (property) and a stateful test (invariant).
  • Example of a property test.
  • Example of an invariant test.
  • Explanation of what the context is used for.
  • Mention that rv tests properties probabilistically.
  • (Once/If merged) Documentation of Custom manifest file support #107 about custom manifest support.
  • (Once/If merged) Documentation of Add printed events to the context for assertions #59 on post-assertions defined by users.
  • Explanation of the 4GB memory limit on Wasm programs, as discussed here.
  • Why you should not set a higher number of runs than 50K, as discussed here.
  • Future support for formal verification, which would check all paths exhaustively.

This will make it easier for users to understand rv, use it correctly, and avoid common mistakes.

@moodmosaic moodmosaic added the documentation Improvements or additions to documentation label Feb 18, 2025
@BowTiedRadone BowTiedRadone linked a pull request Feb 19, 2025 that will close this issue
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant