refactor(test): cleanup /cannon test structure and documentation #16211
+82
−61
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.
This PR refactors part of the test suite within the
/cannon
folder as part of a broader effort to standardize structure, documentation, and formatting across the codebase.The goal of this PR is to land the straightforward refactors first. More complex files, due to custom setup logic, heavy internal dependencies, or unclear structure, will be handled in a follow-up PR to avoid blocking progress and reduce review scope.
Common changes applied where applicable:
*_TestInit
contractsTestInit
@title
and@notice
tags to all test contracts@notice
comments describing expected behavior under test@dev
tags with@notice
where appropriateProgress
Refactored 2 of 3 test files (66.6% complete)
MIPS64.t.sol
MIPS64Memory.t.sol
PreimageOracle.t.sol
(deferred)This remaining file will be refactored in a future PR.