Agent skill
function-docstrings
Write concise docstrings for functions. Use when a junior developer needs help describing inputs, outputs, and errors.
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.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?