关于 review-rust-docs
这项技能依据项目规范审查 Rust crate 或模块文档，并报告不符合要求的位置及改进建议。
主要功能
- 01审查 Rust 文件文档
- 02接受 crate、文件或目录路径
- 03依据项目文档规范检查
- 04报告问题并提出改进建议
适用场景
- 01审核 Rust crate 文档
- 02检查模块目录中的文档
- 03查找并改进不符合规范的文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/review-rust-docs确认已加载。
详细介绍
审查 Rust 文档
阅读 Rust crate 或模块的文档，确保其符合我们的要求和标准。
参数
<path>：需要审查文档的 Rust crate 或文件的路径。<path 1> <path 2>：需要审查的多个 crate 或文件
如果路径不包含 src/，则假定其位于 src/redisearch_rs 目录中。例如，numeric_range_tree 对应 src/redisearch_rs/numeric_range_tree。
如果路径指向一个目录，则审查该目录中所有 Rust 文件的文档。
说明
阅读指定 Rust 文件的文档，并确保其符合 rust-docs-guidelines 中的准则。
列出你发现的所有不符合规范的位置，并说明不符合规范的原因及改进建议。
评论
支持 Markdown