docs(changelog): fold the later entries into the tightened style - #1001
Merged
Conversation
448da9b rewrote the unreleased notes to one line each: what changed, the effect, an issue reference, and none of the debugging narrative. Six PRs merged after it added entries written from their PR bodies instead, so the section had two registers in it -- and two separate "### Added" headings. Those six are now in the same shape as the rest. Nothing is dropped: all 23 entries survive, the longest line goes from 353 characters to 180, and every user-facing fact is still stated. What goes is the reasoning about why a bug existed, which belongs in the commit and the PR, not in notes someone reads to find out whether to upgrade. Also filled in the five references that were missing. They were all changes whose PRs landed in this series -- #967, #968, #969, #977, #978 -- so the numbers are known rather than guessed; each was checked against the commit it names.
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.
🤔 Background
448da9brewrote the unreleased notes to one line each — what changed, the effect, an issue reference, and none of the debugging narrative. Six PRs merged after it added entries written from their PR bodies instead, so the section had two registers in it, and two separate### Addedheadings.💡 Changes
Those six are now in the same shape as the rest.
### AddedheadingsNothing is dropped. Every user-facing fact is still stated. What goes is the reasoning about why a bug existed — that belongs in the commit and the PR, not in notes someone reads to decide whether to upgrade.
🔗 The five missing references
All were changes whose PRs landed in this series — #967, #968, #969, #977, #978 — so the numbers are known rather than guessed. Each was checked against the commit that names it.
✅ Verification
make lint· every(#N)in the section resolves to a merged PR or an existing issue.