Docstring and Comment Pass skill for Claude and Codex
Docstring and Comment Pass as an AI skill. It asks for Code, Language, Docstring style and 3 more, then does the rest. Free to install in Claude or Codex.
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a source file or function has missing, noisy or stale comments and docstrings and needs them rewritten to explain why rather than what. Do not use for writing project documentation or renaming and restructuring code. Related topics: coding, writing.
What it will ask you for
- Code (longer free text)
- Language (free text, e.g. "Python or TypeScript or Go")
- Docstring style (choose one: Google, NumPy, JSDoc, Plain sentences, Match existing)
- Who reads this code (free text, e.g. "Teammates or open source users or future me")
- Public API only (choose one: Yes, No)
- Business context (longer free text)
How it works
- Read the code and mark each spot that is non-obvious: workarounds, business rules, ordering constraints and edge cases.
- Add comments at those spots that give the reason, including why the obvious alternative was not used.
- Remove or flag comments that restate the code or are stale, and suggest a rename where a better name replaces the comment.
- Write docstrings for the public items in the chosen style with purpose, parameters, return value, errors and a brief example.
- List every place where the reason is unknown and ask the author, leaving code behaviour untouched.
What you get
The annotated code with unchanged logic, then a list of removed comments with reasons and a list of open questions for the author.
What it watches out for
- Inventing a plausible reason for a strange line, which gives future readers false confidence.
- Commenting every line, which buries the few comments that matter.
- Editing code while polishing comments, which hides a behaviour change inside a documentation diff.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.