Repository navigation
chore: trim a comment defending code that no longer exists - #19
Merged
Merged
Conversation
The middle paragraph of the comment above the changelog-trimming awk block justified a fenced-block guard against promoting a shell comment into a Markdown heading — logic for demoting headings that isn't in this file. It was written for an earlier `##` header, which needed the quoted release's headings pushed down a level to avoid outranking it; once the header went to `#`, headings already nest correctly with nothing to rewrite, and the demotion code (and its guard) was removed along with the need for it. The comment defending that guard stayed. Every other comment in this block explains what the code does; this one explained what it doesn't do and why not, for a decision the code no longer makes. Folded to one line.
Contributor
🤖 release-please PREVIEWWhat merging this PR into 🤖 I will create a release beep boop1.5.1 (2026-09-07)Bug Fixes
This PR was generated with Release Please. See documentation. Predicted from |
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.
Comment-only. No behavior change.
Found while auditing for useless multiline comments. The middle paragraph above the changelog-trimming
awkblock justified a fenced-block guard against promoting a shell comment into a Markdown heading — logic for demoting headings that isn't in this file any more.It was written for an earlier
##comment header, which needed the quoted release's headings pushed down a level so the version heading wouldn't outrank the header framing it. Once the header became#(in an earlier PR), headings already nest correctly with nothing to rewrite, and the demotion code — plus the fenced-block guard protecting it — was removed. The comment defending that guard's existence stayed behind.Every other comment in this block explains what the code does; this one explained what it doesn't do and why not, for a decision the code no longer makes. Folded to one line that states the current (simple) behavior instead.
pre-commit run --files action.ymlpasses.