Claude Code Pipecat docstring 技能:为 Python 方法补 Google 风格文档
EnglishClaude Code 安装步骤
- 打开固定版本的仓库工作副本,确认 `.claude/skills/docstring/SKILL.md` 存在。
- 从仓库根目录启动 Claude Code,输入 `/docstring` 并描述要处理的内容与验证目标。
中文摘要
读取实际 Python 模块或类,按 Pipecat 的约定为方法写摘要和参数说明,并在需要时解释返回值与异常。适合补文档而保持接口行为。
SKILL.md 中文导读
可复现示例
给虚构的 `calculate_frames(duration, rate)` 补 docstring。函数根据秒数和采样率返回整数帧数,负数秒会抛 ValueError。只写文档。工作步骤
- 先读取签名、实现与测试,核对参数、默认值和失败条件。
- 按适用的 Google 风格段落组织内容,并对照实现复查。
验收方法
应有简短摘要,说明两个参数的单位、整数返回值和真实抛出的 ValueError。原签名及实现保持原样。
GitHub 原文 · 更新日期
适用环境
需要 Claude Code、含固定版本技能的 Pipecat 工作副本及要说明的模块或类。
常见问题
每个方法都需要 Raises 段吗?
方法确实会抛出调用方需要知道的异常时再写。注明何时触发,避免猜测或重复无关异常。