SuperAPI AI 工具集

docstring

编程与开发

查看项目

更新于 10-16 03:41

技能介绍

用途:为 Python 模块与类补写 Google 风格 docstring,遵循 pipecat 项目约定。输入参数可以是类名(如 VADAnalyzer)或模块路径(如 src/pipecat/audio/vad/vad_analyzer.py)。若给模块路径则直接读取该文件;若给类名则在 src/pipecat/ 下搜索 class ClassName,出现多个匹配时列出全部文件路径并询问用户要文档化哪一个,等待确认后再继续。

主要能力:先通读模块,识别类、函数与重要类型别名并理解各组件用途,然后按顺序补齐文档:模块 docstring(位于导入之后)、类 docstring、init 构造参数、公开方法(不以 _ 开头)、带字段说明的 dataclass/config 类。模块格式为一行用途说明加可选扩展说明;类与构造函数、方法用 Args/Returns/Raises 等段落;dataclass 和枚举用 Parameters 段描述字段或取值。

跳过与不改动:私有方法(以 _ 开头)、简单 dunder 方法(str、repr、post_init)、极简的直通 property;已具备一行摘要及必要 Args/Returns 段落的完整 docstring 保持原样,只补缺失或不完整之处。列举事件处理器时不使用反引号,示例用 Example:: 段展示装饰器与函数签名。风格要求简洁专业、以动词开头、先讲目的再讲实现,参数说明包含类型提示、默认值与用途,不重复签名中的类型信息,代码引用用反引号。废弃代码使用 .. deprecated:: X.X.X 段落并指向替代类。完成前需运行 /prose-review <path> 并修复其标记的问题。

适用场景:为 pipecat 代码库中的 Python 模块与类统一补充或改进文档。限制:面向 pipecat 项目结构(默认在 src/pipecat/ 下搜索类),资料未提供其他包路径或配置方式;未提供具体安装命令及收费信息。