Repository navigation
docs(changelog): open the unreleased notes with a short summary - #170
Merged
Merged
Conversation
The opening paragraph is now a list that a user can take in at a glance: the four changes that most code needs, the markers for rungs that don't decode, the stricter field checks, the new functions and the codes to match on. It names FieldError where it said every refusal, because a CSV syntax error has no code, and it names laddercodec.replace(), which is not dataclasses.replace(). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The summary now lists the Rung constructor, which no longer takes a row count, and warns that a check() finding holds CLICK's id in click_id, where v0.4.0 held it in code. It says that a program CLICK saved with a refused value decodes as the instruction, where v0.4.0 decoded it as raw, and it lists the three new functions one by one. Instruction fields are named after their CSV arguments, here and in the rename entry, because some of them, such as Math.dest, are positional. The pointer to Breaking changes closes the list. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The code line now names only FieldError, because the next line covers check() findings. That line says a finding names its shape in code, and the refusal line states the FieldError in a sentence of its own. Co-Authored-By: Claude Opus 5.5 <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.
The opening of the Unreleased CHANGELOG section is the first thing a user reads in the 0.5.0 release notes. It was a single paragraph of nine sentences that mixed new features with breakage. It is now a short list that a user upgrading from v0.4.0 can take in at a glance.
The list covers these points:
decode()returns a list;Rungconstructor;ContactandCoilby kind;laddercodec.replace().codeandclick_idon aFieldError.check()'scodeandkind, with the line to write.It ends by pointing to Breaking changes. One word changes in the rename entry: CSV "keywords" becomes CSV "arguments", because
Math.destis positional. Nothing else in the file changes.Each claim was checked against the code and the
v0.4.0tag. A reviewer passed each commit.Gate:
make lintandmake docs-buildpassed. The change is docs only, so CI runs the tests.