Attribute Macro document_examples 

#[document_examples]

Inserts a ### Examples heading and validates doc comment code blocks.

This attribute macro expands in-place to a ### Examples heading. Example code is written as regular doc comments using fenced code blocks after the attribute. Every Rust code block must contain at least one assertion macro invocation (e.g., assert_eq!, assert!).

Syntax

#[document_examples]
///
/// ```
/// let result = add(1, 2);
/// assert_eq!(result, 3);
/// ```
pub fn add(x: i32, y: i32) -> i32 { ... }

Generates

A ### Examples heading is inserted at the attribute’s position. The code blocks in the doc comments are validated but not modified.

Errors

• Arguments are provided to the attribute.
• No Rust code block is found in the doc comments.
• A Rust code block does not contain an assertion macro invocation.
• The attribute is applied more than once to the same function.