Repository navigation
docs(test): document the scenario-based fuzz engine in rustdoc - #193
Merged
Merged
Conversation
Add a module overview of `simplex::fuzz`: how a `Scenario` describes the transaction and its programs, what the engine does with each case, and the findings a run can fail with. Document `Expect`'s variants, the engine's public fields and builder methods, what `run` panics on, how witness requirements are violated on purpose, and the undocumented getters of `FuzzCase` and `FuzzProgram`. Correct `mutations()`, which mutates half of the cases that don't violate a requirement, not half of all cases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
schoen
force-pushed
the
docs/rustdoc-fuzz
branch
from
November 2, 2026 21:57
f3ff9c5 to
d1540fb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a module overview of
simplex::fuzz: how aScenariodescribes the transaction and its programs, what the engine does with each case, and the findings a run can fail with.Document
Expect's variants, the engine's public fields and builder methods, whatrunpanics on, how witness requirements are violated on purpose, and the undocumented getters ofFuzzCaseandFuzzProgram. Correctmutations(), which mutates half of the cases that don't violate a requirement, not half of all cases.