Skip to content

docs(changelog): open the unreleased notes with a short summary - #170

Merged
ssweber merged 3 commits into
mainfrom
docs/notes-summary
Nov 20, 2026
Merged

ssweber merged 3 commits into
mainfrom
docs/notes-summary

Conversation

@ssweber

@ssweber ssweber commented Nov 20, 2026

Copy link
Copy Markdown
Owner

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:

  • The five changes that code which reads, builds or edits rungs in Python needs:
    • decode() returns a list;
    • the Rung constructor;
    • Contact and Coil by kind;
    • fields named after their CSV arguments;
    • frozen instructions and laddercodec.replace().
  • Rungs that can't be read.
  • The stricter field checks, and how a refused stored value now decodes.
  • The new functions.
  • code and click_id on a FieldError.
  • The swap of check()'s code and kind, 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.dest is positional. Nothing else in the file changes.

Each claim was checked against the code and the v0.4.0 tag. A reviewer passed each commit.

Gate: make lint and make docs-build passed. The change is docs only, so CI runs the tests.

ssweber and others added 3 commits November 20, 2026 09:52
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>
@ssweber
ssweber merged commit 209dd5c into main Nov 20, 2026
7 checks passed
@ssweber
ssweber deleted the docs/notes-summary branch November 20, 2026 15:06
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