Skip to content

docs: lay out the unreleased changes and cut the roadmap for the release - #169

Merged
ssweber merged 9 commits into
mainfrom
docs/release-tidy
Nov 20, 2026
Merged

ssweber merged 9 commits into
mainfrom
docs/release-tidy

Conversation

@ssweber

@ssweber ssweber commented Nov 20, 2026

Copy link
Copy Markdown
Owner

This gets main ready for the 0.5.0 release. It changes only docs and deletes one stale script.

What changes:

  • CHANGELOG. The ## Unreleased section is now laid out for a caller who is upgrading from v0.4.0. It opens with a summary, then has Breaking changes, Added, Changed and Fixed.
    • Each breaking entry says what to write now.
    • Where the exception class that a caller catches has changed, the entry says what to catch now.
    • Each claim about v0.4.0 was checked against the v0.4.0 tag, and several by decoding with v0.4.0.
    • The entry for fix(send-receive): write a TCP address without leading zeros #168, a TCP address written without leading zeros, is under Breaking changes.
    • The 0.4.0 section and the older ones are unchanged.
  • Roadmap. scratchpad/roadmap.md now lists only what is still to do. It went from 850 lines to about 600.
    • Each item that was deleted was checked against main first.
    • Settled records two of Sam's rulings from 2026-11-20: the name addresses(), and a padded TCP address read as decimal and written without leading zeros.
    • "Before the tag" has two steps: this PR merges, then Sam tags laddercodec, ahead of pyrung.
    • After the release, the order is FieldError.span, the whole-program check, the deferred message wording, then the other follow-ups.
    • It names the nine grids that CLICK has not answered yet.
  • devtools/gen_modbus_coverage.py is deleted. Its output no longer matches the Send and Receive coverage goldens, and nothing calls it.

The release notes draft is the Unreleased section under the heading ## 0.5.0. The version comes from the tag, so the heading here stays ## Unreleased.

Gate: make lint, make test (19166 passed, 139 skipped) and make docs-build passed on 9f7775d. The commits after it change only CHANGELOG.md and scratchpad/roadmap.md, and make lint and make docs-build passed on each.

Nothing in this PR waits on Sam. The tag and the release are his.

ssweber and others added 9 commits November 20, 2026 09:21
The Unreleased section had Added, Fixed, Changed and Behaviour changes,
and several entries under Fixed and Changed broke a caller's code. It now
has a summary, then Breaking changes, Added, Changed and Fixed. Each
breaking entry ends with what to write now. Entries about one thing are
merged, such as the field renames of every family and the values that the
field checks now refuse.

Two entries described a state that v0.4.0 did not have, and are corrected.
A Math real that CLICK cuts in positional form is refused, not written in
its E form. A Copy drops the plus of a real only, not of an integer. The
empty-flag entry now says that decode reads such a flag as set, where
v0.4.0 read it as clear.

The one-off generator devtools/gen_modbus_coverage.py is deleted. Its
output no longer matched the Send and Receive coverage goldens, and
nothing referenced it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The summary no longer says that v0.4.0 stopped at a refused value, or that every error has a code. Each breaking entry where the old exception class is not a parent of the new one says what to catch again. The reworded refusal messages, the check() field rename and the new check() findings are breaking entries now, and Tee(UnknownCondition) is back under the Rung and Tee entry. Copy.suppress_zero is None by default only for a real or DF source copied to text.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Copy into TXT entry now says that CLICK's saves of any number constant whose text fills more than one TXT decode as the Copy, such as -5 or 1.5 into TXT1. v0.4.0 decoded these as raw(Copy,...). The reworded-messages entry drops a sentence that its Match step already covers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The roadmap listed work that is on main: the ids, frozen instructions and
rung grid, the code-names review, the tree, rows and bundle entries for
pyrung, and every item 3 bullet marked closed. Those are deleted. Partly
done items keep only what is still to do.

The Order section is replaced by Next steps: Sam tags laddercodec first,
then pyrung, and the order after the joint release. Sam's rulings of
2026-11-20 on addresses() and on a padded TCP address are recorded under
Settled.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…fore the tag

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
fix/ip-canonical is on main as #168, so the release tidy is now the first step before the tag.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Send's TXT count is a rule now: an even count of 2 to 246 characters, with OBJ-029 for an odd one. The unit item now names only the falsy units that an event drum and a toggle still accept. The list of ids that check() reports gains C0002, and the Number constant into TXT item no longer points at a section that holds none of its cases.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…of a TCP address

The Copy into TXT entry now states the end that CLICK saves once, then gives the decode, conversion and DF pointer changes as steps. A DF pointer copied to TXT with real numbering now decodes as exponential=0, where v0.4.0 read suppress_zero=1, and one with exponential numbering decodes as the Copy, where v0.4.0 kept it raw. The TCP address step also names CSV text that holds the address.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
decode_program() reads CLICK's saves of a number constant or a DF pointer copied to TXT as decode() does, so both decode steps name it. Two roadmap items are wrapped to the file's width.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ssweber
ssweber merged commit 9425267 into main Nov 20, 2026
7 checks passed
@ssweber
ssweber deleted the docs/release-tidy branch November 20, 2026 14:50
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