review-comments

Review comments and docstrings for accuracy and relevance across files.

6|14|Updated May 7, 2019
One-click install
npx skills add https://github.com/irudik/repo-template --skill review-comments-irudik
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-comments
Source: https://github.com/irudik/repo-template/tree/main/.agents/skills/review-comments
Command: npx skills add https://github.com/irudik/repo-template --skill review-comments-irudik

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enhances code quality by identifying and rectifying issues in comments, docstrings, and documentation, ensuring they are accurate, concise, and aligned with the codebase.

Core Features & Use Cases

  • Comment Cleanup: Removes outdated or misleading comments and commented-out code.
  • Docstring Alignment: Ensures docstrings accurately reflect the function's behavior.
  • Documentation Sync: Verifies that READMEs and other documentation match the current state of the code.
  • Use Case: After significant code refactoring, use this Skill to automatically audit all comments and docstrings, ensuring they are up-to-date and accurate, preventing confusion for future developers.

Quick Start

Review all comments and docstrings within the '/src' directory for accuracy and clarity.

Frequently Asked Questions about review-comments

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

FAQPage Schema
How do I clean up stale comments and docstrings after refactoring code?

To clean up stale comments and docstrings after refactoring, you can audit specified directories to identify outdated comments, commented-out code, and misleading documentation, then review findings before edits are applied.

What is the best way to remove commented-out code from my source files?

The best way to remove commented-out code is to run an automated audit across your directories that flags dead code blocks for approval before deletion, ensuring no necessary logic is lost.

Can I enforce custom style references for comment density and formatting?

Yes, you can enforce custom style references for comment density and formatting by supplying specific guidelines, which the audit uses to evaluate and standardize comments and docstrings across your files.

Does the comment review process require manual approval before editing files?

Yes, the comment review process requires manual approval before editing files, presenting all identified issues like misleading docstrings and dead code for your review to ensure accurate modifications.

How do I ensure docstrings accurately reflect function behavior?

To ensure docstrings accurately reflect function behavior, scan your codebase to detect misaligned docstrings, verifying that the documentation matches the actual implementation before applying updates.