review-rust-docs

Rust ドキュメントのレビュー

Rust のクレートまたはモジュールのドキュメントを読み、要件と基準を満たしていることを確認します。

引数

• <path>：ドキュメントをレビューする Rust クレートまたはファイルのパスです。
• <path 1> <path 2>：レビューする複数のクレートまたはファイルです。

パスに src/ が含まれていない場合は、src/redisearch_rs ディレクトリ内にあるものとします。たとえば、numeric_range_tree は src/redisearch_rs/numeric_range_tree になります。 パスがディレクトリを指している場合は、そのディレクトリ内にあるすべての Rust ファイルのドキュメントをレビューします。

手順

対象の Rust ファイルのドキュメントを読み、rust-docs-guidelines に記載されたガイドラインを満たしていることを確認します。

要件に準拠していない箇所をすべて報告し、準拠していない理由と改善案を説明します。