Document Rust code with rustdoc-compliant doc comments.
npx skills add https://github.com/hashintel/hash --skill documenting-rust-code
Please help me install this Agent Skill. Skill: documenting-rust-code Source: https://github.com/hashintel/hash/tree/main/.claude/skills/documenting-rust-code Command: npx skills add https://github.com/hashintel/hash --skill documenting-rust-code
This Skill provides comprehensive guidance for writing high-quality Rust documentation in the HASH repository, ensuring consistency, navigability, and adherence to rustdoc conventions. It streamlines code understanding, accelerates developer onboarding, and reduces the effort required to maintain accurate API documentation.
# Errors sections, linking error variants, and to use # Panics for functions that might panic, ensuring complete API contracts.[...] syntax for internal and standard library type references, making your documentation highly navigable and interconnected.# Examples sections for public APIs, demonstrating practical usage and error handling, making your code easier to adopt.# Errors section with intra-doc links for all potential error variants, and include a practical code example demonstrating its usage.Use the documenting-rust-code skill to write documentation for the 'create_user' function, including its parameters, return value, and potential errors.
High-intent search queries and answers about installing and using this skill.
Rustdoc comments start with a single-line summary, then add inline parameter descriptions for simple functions or explicit `# Arguments` sections for complex ones. Include `# Errors` for fallible functions, `# Panics` if applicable, intra-doc links using `[`...`]` syntax, and compilable `# Examples` blocks demonstrating usage.
API documentation requires a concise summary, parameter and return value descriptions, `# Errors` sections with intra-doc links to error variants, `# Panics` for panic conditions, `# Performance` notes when relevant, and compilable code examples showing practical usage and error handling patterns.
Intra-doc links use `[`type_name`]` syntax to reference functions, types, traits, and modules within your crate or the standard library. They create clickable connections in generated HTML docs, improving navigability and making documentation more interconnected and discoverable.
Yes, `# Examples` sections in doc comments contain compilable Rust code that demonstrates function usage. These examples run during `cargo test`, catching documentation drift and ensuring examples remain valid as code evolves.
All fallible functions—those returning `Result` types—require `# Errors` sections listing potential error variants with intra-doc links and descriptions. This documents the complete API contract and helps users understand failure modes and error handling.
Rustdoc is Rust's built-in documentation generator that enforces rustdoc-compliant conventions through linting and compilation. It validates doc comment structure, intra-doc links, and example code, ensuring consistency and high-quality API documentation across public types, functions, traits, and modules.
aRustyDevGenerate Rust crate documentation with cargo doc to expose APIs and structure.
RigohlGenerate Rust crate and module documentation following rustdoc conventions.
bifrost-proxyAutomate Rust project validation with cargo fmt, clippy, and tests.
aRustyDevStandardize Rust documentation with rustdoc conventions and intra-doc links.