rustdoc

Enforce Rust documentation conventions per RFC 1574 for public items.

34|1|Updated Dec 23, 2025

Search Tags:#documentation #coding standards #rust #doc comments #rustdoc #rfc 1574

Ready to run

npx skills add https://github.com/uwu/flora --skill rustdoc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: rustdoc
Source: https://github.com/uwu/flora/tree/main/.agents/skills/rustdoc
Command: npx skills add https://github.com/uwu/flora --skill rustdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers adhere to Rust's official documentation conventions, ensuring clarity, consistency, and discoverability in their code comments.

Core Features & Use Cases

Standardized Doc Comments: Learn and apply the correct format for summary sentences, section headings, and type references.
Example Generation: Understand how to effectively include usage examples and error documentation.
Use Case: When documenting a new public function in a Rust library, use this Skill to ensure your doc comments follow RFC 1574, making the function easier for others to understand and use.

Quick Start

Follow the rustdoc conventions to write clear and effective documentation comments for your Rust code.

Frequently Asked Questions about rustdoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write doc comments for public Rust items?▼

Doc comments for public Rust items should follow RFC 1574 conventions. This includes writing clear summary sentences, using standard section headings, referencing types correctly, and providing usage examples to ensure code discoverability and maintainability.

What are the Rust documentation standards for summary sentences and examples?▼

Rust documentation standards require summary sentences to be concise and clear. Section headings, type references, and examples must follow established conventions to ensure that doc comments are consistent and easily understandable for other developers.

How do I apply RFC 1574 conventions to my Rust library code?▼

Apply RFC 1574 conventions by structuring your documentation with standardized doc comments. Ensure your public functions include proper summary sentences, section headings, type references, and error documentation to meet Rust's official best practices.

Does my Rust code need doc comments for every public item?▼

Public Rust items require doc comments to ensure clarity, consistency, and discoverability. Applying documentation conventions to public functions and libraries helps others understand and use your code effectively.

What is the best way to document error handling in Rust libraries?▼

The best way to document error handling in Rust libraries is by following RFC 1574 conventions. This ensures your error documentation and usage examples are clear, concise, and consistent with established community standards for code maintainability.

Why does my Rust documentation fail to follow standard conventions?▼

Rust documentation fails to follow standard conventions when summary sentences, section headings, or type references are missing or incorrectly formatted. Adhering to RFC 1574 ensures your doc comments meet the required clarity and consistency standards.