Agent skill
function-docstrings
Write concise docstrings for functions. Use when a junior developer needs help describing inputs, outputs, and errors.
Stars
163
Forks
31
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/function-docstrings
SKILL.md
Function Docstrings
Purpose
Write concise docstrings for functions.
Inputs to request
- Function signature and behavior.
- Edge cases or error conditions.
- Project docstring style guide.
Workflow
- Describe purpose in one sentence.
- List parameters with types and meaning.
- State return value and error conditions.
Output
- Docstring block in project style.
Quality bar
- Keep wording precise and minimal.
- Match the project formatting style.
Didn't find tool you were looking for?