rustdoclisted

# Rust Documentation Conventions (RFC 1574) Apply these rules when writing doc comments (`///`) on public Rust items. ## Summary Sentence Every doc comment starts with a single-line summary sentence. ```rust // DO: third person singular present indicative, ends with period /// Returns the length of the string. /// Creates a new instance with default settings. /// Parses the input and returns the result. // DON'T: imperative, missing period, or verbose /// Return the length of the string /// This function creates a new instance with default settings. /// Use this to parse the input and get the result back. ``` ## Comment Style Use line comments, not block comments. ```rust // DO /// Summary sentence here. /// /// More details if needed. // DON'T /** * Summary sentence here. * * More details if needed. */ ``` Use `//!` only for crate-level and module-level docs at the top of the file. ## Section Headings Use these exact headings (always plural): ```rust /// Summary sentence. /// /// # Examples /// /// # Panics /// /// # Errors /// /// # Safety /// /// # Aborts /// /// # Undefined Behavior ``` ```rust // DO /// # Examples // DON'T /// # Example /// ## Examples /// **Examples:** ``` ## Type References Use full generic forms and link with reference-style markdown. ```rust // DO /// Returns [`Option<T>`] if the value exists. /// /// [`Option<T>`]: std::option::Option // DON'T /// Returns `Option` if the value exists. /// Returns an optional value. ``` ## Exa