refactor: rename state Assay check to Verify#139
Merged
Conversation
Signed-off-by: Joshua Temple <[email protected]>
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.
What this change does
Renames the
stateengine's trust-boundary check fromAssaytoVerify(pre-v1; latest released tag isstate/v0.2.0):Machine.Assay(state, entity)→Machine.Verify(state, entity), withAssayError→VerifyErrorandAssayOption→VerifyOption.Verifyfrom the metaphor verbs to the plain, discoverability-first verbs (alongsidePlanPath,Requirements,Trace). The other foundry verbs (Forge,Temper,Quench,Cast,Fire) are unchanged.authoring/assay.md→authoring/verify.md(+ slug/cross-link + theverify-gatebrand image), CHANGELOG bullet under the staged[1.0.0]section.Why
Assayis an uncommon word, and even knowing it ("test a metal sample") it doesn't signal what the call does: confirm an externally-hydrated entity legally satisfies a state's requirements.Verifysays exactly that and pairs with the already-plainRequires/Requirements. This follows the package's own stated rule: operations that favor discoverability over metaphor stay plain. Doing it now, before thestate1.0 tag, keeps it out of the frozen stable surface.Checklist
git commit -s) per the DCOtype: subject)state,source, andsource/statemachinebuild/test/vet green; docsgen clean