docs: merge the duplicated Unreleased headings in CHANGELOG - #43
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Two PRs landed under [Unreleased] independently and each brought its own headings, leaving the section with `### Fixed` twice — separated by `### Changed`, `### Documentation`, and `### Added` — so half the fixes sat below a heading a reader had already passed. Reordered to the Keep a Changelog sequence, with `Documentation` (this project's own addition) trailing the standard set. Every entry is carried over verbatim; the bullet set is byte-identical before and after, 15 either way. Worth doing before cutting a release rather than during, since the release notes are generated from this section and a duplicated heading reads as an editing mistake in a published artifact.
patramsey
force-pushed
the
docs/changelog-unreleased-order
branch
from
August 20, 2026 13:17
2cddfc6 to
b738bd8
Compare
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
1 participant
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.
#39 and #41 each landed under
[Unreleased]with their own headings, so thesection ended up with
### Fixedtwice — separated by### Changed,### Documentation, and### Added:Reordered to the Keep a Changelog sequence (Added, Changed, Fixed), with
Documentation— this project's own addition — trailing the standard set.Every entry is carried over verbatim. The set of bullets is byte-identical
before and after, 15 either way; only the grouping changed.
Worth fixing before a release rather than during, since the notes are generated
from this section and a duplicated heading reads as an editing mistake once
published.