Claude Code molq-docs:审查 Python 公共导出和文档字符串
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/molq-docs/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/molq-docs/`,把核对后的文件保存为 `.claude/skills/molq-docs/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/molq-docs`。
中文摘要
核对 Python 模块公开符号是否具备 Google 风格文档字符串,并检查 API 文档与导出是否同步。
SKILL.md 中文导读
可复现示例
审查样例 doc-24 的公开符号 build_preview() 和 list_labels() 都在 __all__ 中。前者有完整文档字符串,后者没有文档字符串。工作步骤
- 列出模块中的公开符号及导出声明,核对文档字符串实际覆盖。
- 单独报告格式不全与缺失项,再检查文档目录中的 API 页面。
验收方法
模块报告记录 {documented: 1, exported: 2, coverage: '50%'},指出缺少 list_labels(),再核对公共 API 页面是否能找到它。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 中打开 molq 源码。准备待查模块、公共导出声明和仓库文档目录。
常见问题
空文档字符串和格式不全怎样区分?
分别记录未覆盖与不完整。检查摘要、参数、返回及适用的异常说明,并把公开导出和 API 文档一起核对。