Skip to content

chore: remove what-comments across all packages#74

Merged
deveshctl merged 1 commit into
mainfrom
chore/remove-what-comments
Jul 8, 2026
Merged

chore: remove what-comments across all packages#74
deveshctl merged 1 commit into
mainfrom
chore/remove-what-comments

Conversation

@deveshctl

Copy link
Copy Markdown
Owner

Summary

  • Removed 107 comments that only restated function/type names or described obvious code flow (no WHY, just WHAT)
  • Retained all why-comments: hidden constraints, workarounds, non-obvious invariants, subtle design decisions
  • Dropped unused errResolver test helper in cmd/testing_helpers_test.go (defined but never called since its introduction)

Scope

32 files across ci/, cmd/, config/, image/, image/engine/, and tui/ — pure deletions, no logic changes.

Test plan

  • CI passes (no code logic changed, only comment lines removed)
  • Diff reviewed: 218 deletions, 0 additions

Strip 107 comments that only restated function/type names or described
obvious code flow. Keep every why-comment (hidden constraints, workarounds,
non-obvious invariants). Also drop unused errResolver test helper.
@deveshctl deveshctl merged commit e91b268 into main Jul 8, 2026
13 checks passed
@deveshctl deveshctl deleted the chore/remove-what-comments branch July 9, 2026 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant