Skip to main content

function-docstrings

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

Source facts

Repository
proflead/codex-skills-library
Last source activity
January 12, 2026 at 16:12
Detected SKILL.md language
English
Stars
159
Forks
36

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
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.
View on GitHub