Proof check reference
Connect documented claims to inspectable evidence
An API comment or user guide can promise behavior the implementation does not deliver. This check validates explicitly recorded claim-evidence cells so the promise has a place for implementation and verification references.
What the check reads
The spec-stage check is a warning and skips when active requirements declare no documented_behaviors. Each cell needs claim, documented_in, implementing_symbol and verify_by fields. signal_present requires a signal_id; test_reference requires a test_ref; manual_review requires a review_note of at least 16 characters. The check verifies documentation and test file paths, stripping supported location suffixes. It does not resolve the named test function or implementing symbol, run the signal or execute a test.
proof audit --check documented_claim_verifiedAn illustrative case
Illustrative case: documentation claims cancellation leaves no partial output. Record that statement, the documentation location, the implementing function and a test reference that exercises cancellation. An existing test file meets the path check even if its assertions never inspect partial output. The reviewer must read the test and its actual result before concluding that the claim holds.
Resolve the finding
- Identify a concrete behavioral promise and record it in documented_behaviors on the relevant requirement. Keep its conditions and exceptions visible.
- Choose the applicable evidence kind and supply a real, useful reference. For a test, verify that its assertion distinguishes the promised behavior from the failure you are concerned about.
- Rerun the structural check, then inspect or execute the referenced evidence as appropriate. Retain the revision, result and limitations needed for someone else to assess the claim.
What a clear result means
A clear result means the declared cells and checked paths meet the implemented floor. It does not discover every promise in documentation, establish that a signal applies to the symbol or prove agreement between code and prose. Despite the check name, structural evidence linkage and behavioral verification remain separate tasks.
Continue with one real issue
Documentation coverage · Acceptance witness quality
Bring one finding, its requirement and the current evidence to scope a walkthrough of what your reviewer can establish and what still needs work.