Clarify that RegisterEventType is the sole registration entry point#14
Merged
Conversation
Spell out, in the RegisterEventType godoc and the README, that an event vocabulary registers via a single RegisterEventType call per event type placed in the package's init function — and that init is where the call goes, not an alternative registration API. Frames it as the database/sql driver idiom so an implementor reaches for the side-effect-import wiring without second-guessing whether there is a non-init path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Docs-only. An implementor of an event vocabulary was unsure whether to register event types via
init()or viaRegisterEventType— treating them as alternatives. They are not:RegisterEventTypeis the only registration call, andinitis simply where a vocabulary places it so a side-effect import wires the whole vocabulary in (thedatabase/sqldriver idiom).This spells that out positively in the
RegisterEventTypegodoc and the README "Register an event type" section. No code change.🤖 Generated with Claude Code