function-docstrings
Write concise docstrings for functions. Use when a junior developer needs help describing inputs, outputs, and errors.
Informations de source
- Dépôt
- proflead/codex-skills-library
- Dernière activité de la source
- 12 janvier 2026 à 16:12
- Langue détectée de SKILL.md
- anglais
- Étoiles
- 167
- Forks
- 37
Options d'installation
Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.
Vérifiez les fichiers source
Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.
Affichage de SKILL.md
SKILL.md
Instructions source · Aperçu en lecture seule- 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.
Voir sur GitHub