docstring
Installation
SKILL.md
Document a Python module or class using Google-style docstrings following project conventions. The argument can be a class name or a module path.
Instructions
-
Determine what to document based on the argument:
If a module path is provided (e.g.
src/pipecat/audio/vad/vad_analyzer.py):- Use that file directly
If a class name is provided (e.g.
VADAnalyzer):- Search for
class ClassNameinsrc/pipecat/ - If multiple files contain that class name, list all matches with their file paths, ask the user which one they want to document, and wait for confirmation
-
Once the file is identified, read the module to understand its structure:
- Identify all classes, functions, and important type aliases
- Understand the purpose of each component
Related skills
More from pipecat-ai/pipecat
pr-description
Update a GitHub PR description with a summary of changes
54changelog
Create changelog files for important commits in a PR
50update-docs
Update documentation pages to match source code changes on the current branch
32pr-submit
Create and submit a GitHub PR from the current branch
29code-review
Automated code review for pull requests using multiple specialized agents
28