python-docstrings

Installation
SKILL.md

Python Docstrings

Use this skill to add or normalize PEP 257 docstrings in Python code so external tools can discover API intent without reverse-engineering the implementation.

Intent Router

Need Load
preferred syntax, extraction path, and caveats references/docstrings.md

Quick Start

  1. Inspect the repository for an existing documentation convention.
  2. Preserve an established machine-readable style when it already works with external tooling.
  3. Otherwise standardize on PEP 257 docstrings for the requested Python surface.
  4. Document public and externally consumed symbols before private helpers.
  5. Keep names, parameters, return semantics, and examples aligned with the real code.

Workflow

Installs
2
First Seen
Jul 8, 2026
python-docstrings — alisonaquinas/llm-software-design