review-rust-docs
Review the documentation of a Rust crate to ensure it meets our requirements and standards.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Review the documentation of a Rust crate to ensure it meets our requirements and standards.
How to use
Przygotuj ścieżkę do pliku lub katalogu Rust, który chcesz sprawdzić. Jeśli ścieżka nie zawiera
src/, skill automatycznie założy, że znajduje się wsrc/redisearch_rs(np.numeric_range_treebędzie interpretowany jakosrc/redisearch_rs/numeric_range_tree).Uruchom skill, przekazując ścieżkę jako argument. Możesz sprawdzić jeden plik, moduł lub wiele plików naraz, podając je jako oddzielne argumenty.
Jeśli wskazana ścieżka to katalog, skill automatycznie przeanalizuje dokumentację wszystkich plików Rust w tym katalogu.
Skill przeczyta dokumentację i porówna ją z wytycznymi zawartymi w
rust-docs-guidelines. Wytyczne obejmują standardy formatowania komentarzy, opisy funkcji, dokumentację publicznych interfejsów i inne wymagania jakości.Otrzymasz raport zawierający listę wszystkich miejsc, w których dokumentacja nie spełnia standardów. Dla każdego znalezionego problemu raport zawiera wyjaśnienie przyczyny niezgodności i sugestię poprawy.
Przejrzyj raport i zastosuj sugerowane zmiany w dokumentacji swoich modułów Rust, aby dostosować je do standardów projektu.