Skip to content
Back to skills

Function Docstrings

ASecurity

Write concise docstrings for functions. Use when a junior developer needs help describing inputs, outputs, and errors.

  • 666 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added February 8, 2026
documentation

Security analysis

A100/100

Scanned February 12, 2026

npx -y skills add majiayu000/claude-skill-registry --skill function-docstrings --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Function Docstrings?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Function Docstrings
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/majiayu000-function-docstrings/badge)](https://www.skillsdirectory.com/skills/majiayu000-function-docstrings)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: function-docstrings
description: Write concise docstrings for functions. Use when a junior developer needs help describing inputs, outputs, and errors.
---

# 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
1. Describe purpose in one sentence.
2. List parameters with types and meaning.
3. State return value and error conditions.

## Output
- Docstring block in project style.

## Quality bar
- Keep wording precise and minimal.
- Match the project formatting style.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.