Review Python code comments and docstrings for redundancy.
npx skills add https://github.com/othercode/profiles --skill commenting-code
Please help me install this Agent Skill. Skill: commenting-code Source: https://github.com/othercode/profiles/tree/main/plugins/django-engineering/skills/commenting-code Command: npx skills add https://github.com/othercode/profiles --skill commenting-code
This Skill helps developers write more effective code comments and docstrings by distinguishing between useful and redundant documentation, leading to cleaner, more maintainable codebases.
help_text).Use the commenting-code skill to review the docstrings and comments in the current Python file.
High-intent search queries and answers about installing and using this skill.
Effective Python docstrings focus on explaining the why behind code logic, documenting interfaces, and providing UI-specific information like help_text. This skill enforces these best practices by flagging comments that merely describe functionality.
The best way to review Python docstrings in a pull request is to check for redundant comments that state what the code does. This skill flags those annotations so authors can remove them and focus on documentation providing real value.
Write Python docstrings to document interfaces and explain the why behind code, while avoiding comments that merely restate what the code does. This skill enforces these rules to distinguish useful annotations from useless ones.
Yes, this code review skill works with Python files, enforcing specific rules for writing and reviewing Python code comments and docstrings to ensure they explain the why rather than the what.
You should remove comments that state what the code does because they are redundant and clutter the codebase. Removing them enforces best practices, leading to cleaner, more maintainable code with documentation that adds real value.
otrebuAnalyze codebases with cloc to compute total lines of code and language distribution.
phuonghxAutomate linting, formatting, type checking, and security audits for Node.js/TypeScript and Python codebases.
microwindAnalyze Python code quality, performance, and type safety.
roach88Generate browsable HTML API documentation from Python docstrings.