Skip to content

docs(changelog): say each S2 change plainly - #283

Merged
Flix6x merged 2 commits into
dev/s2-frbc-completefrom
docs/s2-changelog-legible
Nov 8, 2026
Merged

Flix6x merged 2 commits into
dev/s2-frbc-completefrom
docs/s2-changelog-legible

Conversation

@Flix6x

@Flix6x Flix6x commented Nov 8, 2026

Copy link
Copy Markdown
Member

Into the integration branch dev/s2-frbc-complete (#279), not main.

Answers the review comment on #278 that the changelog's sentence constructions reduce legibility, and that the problem is widespread.

The Unreleased section of CHANGELOG-S2.rst is rewritten entry by entry, and so are the three entries this work added to CHANGELOG.rst:

  • Each entry starts with what changes for the reader.
  • Sentences are short, with plain word order. Constructions such as "the moment a state of charge is known as of included" are gone.
  • The longest entries are split into a lead sentence and a list, with the PR links in a closing line.

No claim is added or dropped. The RST parses without warnings.

The rewrite is done here rather than in #278, because #279 replaces the whole Unreleased section that #278 adds.

🤖 Generated with Claude Code

https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW

Rewrite the Unreleased entries of CHANGELOG-S2.rst, and the three this
work added to CHANGELOG.rst, for legibility: lead with what changes for
the reader, in short sentences with plain word order, and split the
longest entries into a lead sentence and a list. No claim is added or
dropped.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW
Signed-off-by: F.N. Claessen <[email protected]>
@Flix6x Flix6x added the S2 label Nov 8, 2026
@Flix6x Flix6x added this to the 0.10.0 milestone Nov 8, 2026
@coveralls

coveralls commented Nov 8, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 42489871952

Warning

No base build found for commit 2f89b72 on dev/s2-frbc-complete.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 95.175%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 3171
Covered Lines: 3018
Line Coverage: 95.18%
Coverage Strength: 4.57 hits per line

💛 - Coveralls

A check of every entry against the text it replaced found the rewrite
had given the charging-efficiency risk a direction (wrong for a heat
pump, whose COP exceeds one), made "a lower bound" of the hard upper
bound, and dropped or shifted several smaller facts: planning from an
unrecorded state of charge, the storage efficiency named only once
confirmed, the DST boundary rule, abnormal modes being left out of both
capacities and bands, power being converted into power_unit, polling,
and the handler always tracking the batch in force. Restore each.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01CcpawsJs74cSwFLXkz7ZwW
Signed-off-by: F.N. Claessen <[email protected]>
@Flix6x
Flix6x merged commit 95cda29 into dev/s2-frbc-complete Nov 8, 2026
19 checks passed
@Flix6x
Flix6x deleted the docs/s2-changelog-legible branch November 8, 2026 14:29
Comment thread CHANGELOG-S2.rst Resolved
Comment thread CHANGELOG-S2.rst Resolved
Comment thread CHANGELOG-S2.rst Resolved
Comment thread CHANGELOG-S2.rst Resolved
Comment thread CHANGELOG-S2.rst Resolved
Comment thread CHANGELOG-S2.rst Resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants