Claude Code Pipecat Docstring Skill for Google-Style Python Methods
Read the actual Python module or class and document methods using Pipecat conventions. Explain parameters, return values, and exceptions when they apply.
中文Install in Claude Code
Use Claude Code in the pinned Pipecat checkout and identify the module or class to document.
- Open the pinned repository checkout and confirm `.claude/skills/docstring/SKILL.md` is present.
- Start Claude Code in the repository root and call `/docstring` with the work and its verification goal.
Example task
Document a fictional calculate_frames(duration, rate) function. It converts seconds and sample rate into an integer frame count and raises ValueError for negative duration. Change only the docstring.What to check
Expect a short summary, both parameter units, the integer return value, and the observed ValueError. The function signature and implementation stay intact.
Original SKILL.md on GitHub · Updated
Frequently asked question
Does every method need a Raises section?
Add it for exceptions relevant to callers. Describe the condition that raises them and ground it in the implementation.