Summary
The API Reference section in README.md lists method signatures for MockEnvBuilder but omits:
- Return types (every method just says
-> Self)
- Error conditions (what panics, what validates)
- Available feature flags that gate certain methods
What's Missing
| Method |
Missing Info |
.with_wasm(wasm: &[u8]) |
No mention of what happens with invalid WASM |
.with_protocol_version() |
No list of valid versions |
.capture_logs() |
No mention of how to retrieve captured logs |
.track_costs() |
No mention of feature flag requirement |
Proposed Work
- Expand each builder method with a "Panics" / "Errors" sub-section
- Add feature flag annotations (e.g.,
[requires: feature = "snapshots"])
- Cross-link to examples in
examples/ for each method
- Add a "Common Mistakes" callout box
Acceptance Criteria
Summary
The API Reference section in
README.mdlists method signatures forMockEnvBuilderbut omits:-> Self)What's Missing
.with_wasm(wasm: &[u8]).with_protocol_version().capture_logs().track_costs()Proposed Work
[requires: feature = "snapshots"])examples/for each methodAcceptance Criteria
MockEnvBuildermethod documented with panics and errors