Python代码文档补全
输入Python模块路径或类名,检查并补全谷歌风格文档字符串,获得参数、返回值和配置字段说明。
功能与用途
适合为缺少说明的Python代码补齐文档。提供模块路径或类名后,会阅读源码,为模块、类、构造函数和公开方法补充谷歌风格文档字符串,说明用途、参数、默认值、返回值及必要的异常信息。也可补充数据类、配置类的字段说明,以及枚举值和事件处理器示例。已有完整文档会保留,缺失或不完整的说明才会补写。使用时需能访问项目源码;按类名定位默认搜索Pipecat源码目录,遇到同名类需先选择目标文件。
适用场景
- 提交代码前补齐接口说明:为新增模块、类和公开方法补充用途、参数及返回值说明,方便代码审查和后续调用。
- 整理配置与枚举文档:为数据类和配置类补充字段含义、默认值说明,并解释枚举中各个取值的用途。
- 完善事件处理器用法:在类文档中列出事件处理器,并补充装饰器用法和回调函数签名示例。
适用人群
- Python开发者
- Pipecat项目贡献者
- 开源项目维护者
使用步骤
- 提供目标Python模块路径或类名。
- 若出现同名类,选择需要补文档的文件。
- 读取源码,补齐缺失或不完整的文档字符串。
- 检查参数、返回值、字段与事件示例是否准确。
- 运行文案审查并修正发现的问题。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 简单
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Document a Python module and its classes using Google style
使用前准备
- 能够访问目标Python项目源码,并提供模块路径或类名。
- 按类名查找时,默认项目中存在 src/pipecat/ 目录。
- 完整执行收尾检查需要环境支持 /prose-review 命令。