Skip to content

chore: remove redundant comments and clean up code comments#68

Draft
NikolayS wants to merge 1 commit into
mainfrom
claude/cleanup-comments
Draft

chore: remove redundant comments and clean up code comments#68
NikolayS wants to merge 1 commit into
mainfrom
claude/cleanup-comments

Conversation

@NikolayS
Copy link
Copy Markdown
Contributor

Summary

Comment-only cleanup across CLI, reporter, monitoring backend, tests, and quality scripts. No executable code, imports, signatures, or logic touched.

Categories cleaned up:

  • Decorative banner separators (~25 removed)# =========, // --------- banners above describe(...), class Test..., or function definitions where the construct itself already names the section. Hit cli/lib/{reports,checkup,issues}.ts, cli/bin/postgres-ai.ts, cli/test/{reports,reports.cli,init}.test.ts, plus several Python test files.
  • Stale task/issue references (~6 fixed) — Removed "Issue 4/6/7/8/10", "issues 9 & 10", "TODO: add bats tests for this script", and similar markers that belong in git history.
  • Verbose banner block collapsedreporter/postgres_reports.py H001 banner reduced from 15 lines of decorative === framing to a focused 3-line note pointing at where recommendations are actually computed (CLI + UI).
  • What-comments restating code (~4 removed) — e.g., # Skip if queryid is missing directly above if not queryid: continue in the reporter.

Diff: 14 files, +15 / -181.

Test plan

  • Verify git diff origin/main contains comment-only changes (no logic, no imports, no signatures)
  • CLI typecheck still produces the same (pre-existing) result
  • Existing Python and TypeScript test suites pass unchanged

https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS


Generated by Claude Code

Comment-only cleanup; no logic or executable code touched.

- Removed ~25 decorative banner comments (`# =====`, `// -----`) that
  added no information beyond what the adjacent `describe(...)` /
  `class Test...` / function signature already conveyed.
- Removed ~6 stale "Issue N" / "TODO" task references in tests and
  scripts that belong in git history, not source.
- Collapsed one verbose H001 banner block in reporter/postgres_reports.py
  into a focused 3-line note about where recommendations are computed.
- Removed a handful of what-comments restating obvious code
  (e.g., "Skip if queryid is missing" above `if not queryid: continue`).

https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants