Repository navigation
chore: make code comments concise and preserve essential contracts - #5
Merged
Merged
Conversation
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.
Remove decorative section dividers, obsolete task/migration narratives, obvious descriptions and unsupported claims of correctness or safety. Keep short English comments for nonobvious ownership, callback/teardown constraints, units, timeline rules and format limits. Correct stale field annotations and synchronize checked-in Stream Deck JavaScript.
326 comment groups were changed in 65 source files. Including CSS and generated counterparts, the source-preservation check covers 69 files: all surviving source lines match the audit parent, with three named inline field annotations checked separately. License notices and tool directives are retained. No functional code changes are included.
Validation: both TypeScript checks and Vite builds pass with identical production asset hashes to the audit parent; plugin build/socket integration passes and checked-in JS matches compiler output; repository text/diff checks pass. The complete core CI on #4 is green; this branch also runs the workflows. Report evidence is updated in docs/audit/2026-10-08.md.
Stacked on #4, which is based on packaging PR #3. Review/merge order: #3, #4, then this PR. Full Windows build and clean-install runtime limits remain explicit in the audit report.