skills.rest
proven-xyz
proven-xyzOFFICIAL
Explore all skills by this author →
GitHub

clean-comments

Identify and remove stale or misleading Python comments and docstrings.

2|1|Updated Mar 20, 2026
Search Tags:#refactoring#python#code-quality#docstrings#best-practices#static-analysis#comment-cleanup
One-click install
npx skills add https://github.com/proven-xyz/proven-app --skill clean-comments-proven-xyz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: clean-comments
Source: https://github.com/proven-xyz/proven-app/tree/main/.agents/skills/clean-comments
Command: npx skills add https://github.com/proven-xyz/proven-app --skill clean-comments-proven-xyz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Python codebases accumulate stale or redundant comments that mislead or clutter. This Skill helps clean, prune, and correct comments and docstrings to keep documentation accurate and concise.

Core Features & Use Cases

  • Remove obsolete comments that no longer reflect code behavior.
  • Improve clarity by rewriting or removing redundant notes and docstrings.
  • Use in code reviews to ensure maintainable, truthful inline guidance.

Quick Start

Review a Python file and remove stale or redundant comments, keeping only accurate notes.

Frequently Asked Questions about clean-comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I remove stale Python comments and docstrings from my codebase?▼

To remove stale Python comments, apply static analysis to identify and prune obsolete notes that no longer reflect code behavior. This ensures remaining comments are accurate, concise, and aligned with current contracts and utilities.

What is the best way to clean up redundant comments in Python modules?▼

The best way to clean up redundant comments is by reviewing Python modules to remove or rewrite misleading docstrings. This focuses on ensuring comments reflect current behavior while keeping only accurate, essential context for maintainable code.

How does comment cleanup improve Python code quality during code reviews?▼

Comment cleanup improves Python code quality by removing misleading or cluttered documentation during code reviews. It ensures inline guidance and docstrings remain truthful, concise, and aligned with the actual behavior of contracts, utilities, and tests.

Does comment cleanup remove essential context from Python tests and utilities?▼

No, comment cleanup does not remove essential context from Python tests and utilities. It specifically targets obsolete and redundant notes, ensuring that accurate and concise documentation remains to reflect current code behavior.

When do I need to refactor docstrings in Python codebases?▼

You need to refactor docstrings in Python codebases when inline documentation becomes misleading or cluttered. Refactoring docstrings prunes redundant notes and rewrites them to accurately reflect current behavior across modules, contracts, and tests.

Related Skills

Explore More Software Engineering Skills→
victormacaubasvictormacaubas
1

python-code-reviewer

Automate non-destructive Python code reviews with markdown reports.

Community
Advanced
GDSDNGDSDN
3

dev-suggest-refactoring

Analyze codebases to suggest automated refactoring opportunities using AST processing and code metrics.

Community
Advanced
zajcazajca
2

go-linting

Configure golangci-lint with recommended Go linters for static analysis.

Community
Basic
xpgcrxxpgcrx
5

python-dev

Outline Python coding conventions, Google-style docstrings, and refactoring guidelines.

Community
Basic