function-docstrings

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.