Repository navigation
doc: changelog entries carry their old and new IDL lines - #162
Merged
Merged
Conversation
Each changelog entry gains optional `old` / `new` fields: one line of IDL for the declaration or member it's about, printed from the frozen schemas by schema::ir::snippet (a field, a variant, a function signature, an annotation, a validator call, or a declaration kept to one line). Additive, so DOC_MODEL_VERSION stays 1; schemas/doc-model.json regenerated.
This was referenced Nov 1, 2026
Merged
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.
Each changelog entry in the documentation model gains optional
old/newfields: one line of IDL for the declaration or member the change is about, printed from the frozen schemas by a small printer (schema::ir::snippet).! Errorsresolved from ordinals), annotations (@key = value,@deprecated,@validators = [Call(k = v)]), and declarations kept to one line (struct, enum, protocol, error, const, type alias, validator).new, a removal onlyold. Kinds with nothing to print as IDL (docstring changes, error ordinals, guarantees, function reorders, namespace renames) have neither; renderers word those.DOC_MODEL_VERSIONstays 1 (doc model: state the version rule for additive changes #158's rule).schemas/doc-model.jsonregenerated:BreakingChangeEntry/NewFeatureEntry/ModificationEntrywrap the existing change kinds.comline diffoutput is unchanged; onlydoc::Changelogcarries the lines.Feeds the doc renderers' changelog rendering (generation, next in the cascade).