Re: [PATCH V2] rust: Use consistent "# Examples" heading style in rustdoc

From: Miguel Ojeda
Date: Mon Jun 23 2025 - 19:14:35 EST


On Tue, Jun 10, 2025 at 11:03 AM Viresh Kumar <viresh.kumar@xxxxxxxxxx> wrote:
>
> Use a consistent `# Examples` heading in rustdoc across the codebase.
>
> Some modules previously used `## Examples` (even when they should be
> available as top-level headers), while others used `# Example`, which
> deviates from the preferred `# Examples` style.
>
> Suggested-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
> Signed-off-by: Viresh Kumar <viresh.kumar@xxxxxxxxxx>
> Acked-by: Benno Lossin <lossin@xxxxxxxxxx>

Applied to `rust-next` -- thanks everyone!

This is a trivial change that shouldn't be able to break anything
anywhere, and I haven't heard any complaints, so I will go ahead and
take it.

If someone wants to give Acked-by's, I can still take them.

Cheers,
Miguel