Claude Code comment cleanup skill that preserves Python directives
Trim redundant Python comments and docstrings while preserving design reasoning, functional directives, and the syntax tree.
中文Install in Claude Code
Use Claude Code in a PyCyphal Python checkout or an exercise repo that uses type-checker directives. Capture the starting diff and compare syntax trees before and after.
- Review `.claude/skills/comment-cleanup/SKILL.md` and its requirements at the pinned GitHub commit.
- Create `.claude/skills/comment-cleanup/` in your project and save the reviewed file as `.claude/skills/comment-cleanup/SKILL.md`.
- Start Claude Code from that project's root, then select `/comment-cleanup` in the slash menu.
Example task
Prepare a title normalization helper with a comment restating the return and a separate existing type-checker directive. Request a comment-only cleanup.
`normalize_title.py` · `# Return the normalized title` · `# type: ignore[arg-type]`What to check
The diff removes `# Return the normalized title` and preserves `# type: ignore[arg-type]`. With docstrings excluded, the syntax trees should match.
Original SKILL.md on GitHub · Updated
Frequently asked question
Is comparing the syntax trees sufficient?
Some type-checker and formatter directives are outside ordinary syntax tree comparison. Review those lines, run the project type checker, and inspect deletions for lost rationale.