Repository navigation
chore: trim code comments across the repo - #7
Merged
Merged
Conversation
Remove comments that narrate the code, restate names, label sections or describe one specific package, incident or earlier change. XML doc and JSDoc blocks go too. Comments that carry a non-obvious reason are cut to one short line. No code changes. Co-Authored-By: Claude Opus 5.5 <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.
Summary
Cuts the code comments down across the backend, frontend, tests, deploy scripts, workflows and container/nginx config. Comment-only change: no code, configuration values or behaviour change.
Why
Many comments narrated what the next lines do, restated method names, labelled sections, or described one specific package, incident or earlier change instead of the code. They made files longer and went stale quickly. The reasoning behind a change belongs in its pull request, not in the code.
Changes
// ---- Helpers ----,<!-- Header -->), commented-out code, and history notes ("previously…", requirement IDs, phase names)///) and JSDoc (/** */) blocks, following the project convention of no doc commentsdocs/ops/runbookscatchblocks, deliberate Dependabot holds)Notes for reviewers
usage()prints indeploy/deploy.sh,deploy/remote.shanddeploy/backup.sh(sed -n '2,8p'/'2,7p'), the# vX.Y.Zcomments after pinned action SHAs (Dependabot reads them), tool directives, and anything inside strings, heredocs or inline templates.authorized_keysforced-command example, the secret list) are gone. The scriptusage()texts still describe each command.Checklist
developand is about one thingfeat(scope): ...,fix(scope): ...)src/frontend/src/app/core/models