Repository navigation
docs(readme): clarify what adding a dialect actually involves - #16
Merged
Merged
Conversation
The 'adding a dialect' paragraph described a single `Dialect` interface with `Parse`/`Emit` methods, which no longer matches the code: dialect/dialect.go splits it into `Parser` (dialect files to IR) and `Emitter` (IR to dialect files), both embedding a minimal `Dialect`. Name the two interfaces, link to dialect/dialect.go and the CONTRIBUTING section, and note that a target-only dialect needs just `Emit`. Co-Authored-By: Claude Opus 5 (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
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.
Why
The README's "adding a dialect" paragraph described a single
Dialectinterface withParse/Emitmethods. That hasn't matched the code for a while —dialect/dialect.gosplits the work intoParser(dialect files → IR) andEmitter(IR → dialect files), each embedding a minimalDialectthat only carriesName().What
ParserandEmitterexplicitly instead of the stale single-interface description.dialect/dialect.goso the interfaces are one click away.init()registration.Emit— the cheapest useful contribution.Docs only; no code changes.
🤖 Generated with Claude Code