docs: groom the unreleased changelog ahead of the next release - #322
Draft
kkozik-amplify wants to merge 1 commit into
Draft
docs: groom the unreleased changelog ahead of the next release#322kkozik-amplify wants to merge 1 commit into
kkozik-amplify wants to merge 1 commit into
Conversation
Two outside contributors sent the five fixes sitting in Unreleased and the changelog did not say so. This repo has credited contributors by name since at least 6.x; the release is largely their work. Follows the existing convention -- `Thanks, @user` before a single trailing link. @livingstaccato also reported #307-#310, so the credit covers reporting and fixing both. Also switches the Unreleased links from issue numbers to PR numbers to match the rest of the file: 67 /pull/ links against 22 /issues/, and all 20 existing Thanks lines use /pull/. The two strip_string_quotes entries both point at #313 because one PR fixed two reported issues, which is worth listing as two behaviour changes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
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.
Why
Two outside contributors sent the five fixes currently sitting in
Unreleased, and the changelog didn't say so. This repo has credited contributors by name since at least 6.x — dropping it now would be a poor look on a release that is largely their work.Opened as a draft as a holding branch for changelog grooming before the next release, so anything else we want to tidy can land here rather than as a scatter of one-line PRs.
What
Contributor credit
Follows the existing convention exactly —
Thanks, @userbefore a single trailing link (see the7.2.1and7.2.0sections):strip_string_quotes— expression interiorsstrip_string_quotes— escape sequences@livingstaccato also reported #307–#310, so the credit covers both halves of that work.
Link style
The
Unreleasedentries pointed at issue numbers; every other entry in the file points at the PR. The file is 67/pull/links to 22/issues/, and all 20 existingThankslines use/pull/. Switched the sevenUnreleasedentries to match, including thepy.typedline (#298→ its PR#299).Note the two
strip_string_quotesentries now both point at #313. That's correct — one PR fixed two reported issues, and they're worth listing as separate behaviour changes.Deliberately not done
py.typeddeleted from package #298 and the fix was internal (restore py.typed marker (#298) #299). Every existingThanksin this file goes to a PR author, and inventing aReported byconvention felt like the wrong thing to slip into a grooming PR. Easy to add if we want it — say the word.Unrelated thing worth a look
All six issues fixed by these PRs — #307, #308, #309, #310, #315, #316 — are still open, even though each PR carried a recognised
Fixes #N(the API reports them underclosingIssuesReferences) and all merged intomainover 12 hours ago. Auto-close appears not to have fired. Not something this PR touches, but they probably want closing by hand.Test plan
pre-commit run— clean, includingmdformatMERGED