name: review-rust-docs description: 审查Rust crate的文档以确保其符合我们的要求和标准。
审查Rust文档
读取Rust crate或模块的文档,确保其符合我们的要求和标准。
参数
<path>: 需要审查文档的Rust crate或文件的路径。<path 1> <path 2>: 多个crates/文件进行审查
如果路径不包含src/,则假设其在src/redisearch_rs目录中。例如,numeric_range_tree变为src/redisearch_rs/numeric_range_tree。
如果路径指向一个目录,则审查该目录中所有Rust文件的文档。
指令
读取特定Rust文件的文档,并确保它们符合rust-docs-guidelines中概述的指南。
为所有不符合要求的位置生成报告,解释为什么它们不符合,并提出改进建议。