Repository navigation
Refactor: cut the narrative out of the longest comments - #13
Merged
Merged
Conversation
Thirteen blocks explained a past bug, why the obvious alternative was rejected, and what would happen if someone changed the code, at a length that buried the invariant a reader needed. Each is now the invariant and the constraint, in three sentences or fewer. Nothing about the code changed: the token streams are byte-identical with comments stripped. Security invariants, measured limits and JSDoc parameter tables were left alone.
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.
Summary
scripts/is-prerelease.js,scripts/check-frontend-paths.js,scripts/bump-cache-busting.js,api/src/routes/icons.js,api/src/routes/system.js,api/src/routes/config.js,api/src/routes/badges.js,api/src/auth.js(two),api/src/widget-i18n.js,api/src/secret-scope.js,ui/js/link-url.js,ui/js/dashboard-logic.js,ui/js/admin-logic.js(two).svg-sanitize.js,widget-settings.js,widget-secrets.js,badge-headers.js), measured limits (poll-limits.js, which the project requires to be explainable), and JSDoc parameter tables such aswidget-toolbox.js'spolloptions andbadge-logic.js's typedef.Testing
All green. No new tests: comment-only. Verified mechanically — with comments stripped and whitespace collapsed, all 13 files are byte-identical to their previous revision, so no code moved.
Checklist