Skip to content

refactor: rename state Assay check to Verify#139

Merged
joshua-temple merged 1 commit into
mainfrom
refactor/rename-assay-verify
Jun 4, 2026
Merged

refactor: rename state Assay check to Verify#139
joshua-temple merged 1 commit into
mainfrom
refactor/rename-assay-verify

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

What this change does

Renames the state engine's trust-boundary check from Assay to Verify (pre-v1; latest released tag is state/v0.2.0):

  • Machine.Assay(state, entity)Machine.Verify(state, entity), with AssayErrorVerifyError and AssayOptionVerifyOption.
  • Foundry vocabulary doc moves Verify from the metaphor verbs to the plain, discoverability-first verbs (alongside PlanPath, Requirements, Trace). The other foundry verbs (Forge, Temper, Quench, Cast, Fire) are unchanged.
  • Docs page authoring/assay.mdauthoring/verify.md (+ slug/cross-link + the verify-gate brand image), CHANGELOG bullet under the staged [1.0.0] section.

Why

Assay is 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. Verify says exactly that and pairs with the already-plain Requires/Requirements. This follows the package's own stated rule: operations that favor discoverability over metaphor stay plain. Doing it now, before the state 1.0 tag, keeps it out of the frozen stable surface.

Checklist

  • Commits are signed off (git commit -s) per the DCO
  • Conventional commit messages (type: subject)
  • state, source, and source/statemachine build/test/vet green; docsgen clean
  • Public API change documented (godoc, docs site, CHANGELOG)

@joshua-temple joshua-temple merged commit 81b868c into main Jun 4, 2026
121 checks passed
@joshua-temple joshua-temple deleted the refactor/rename-assay-verify branch June 4, 2026 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant