Re: [PATCH] samples: rust_misc_device: fix markup in top-level docs

From: Christian Schrefl
Date: Thu Mar 13 2025 - 15:47:13 EST


On 13.03.25 9:52 AM, Alice Ryhl wrote:
> The meaning of /// is to document the thing that comes after it, so
> currently the example is documentation for the `use core::pin::Pin;`
> statement. To write top-level docs (and have them rendered as such in
> the html by rustdoc), use //! instead.
>
> This does not change the contents of the docs at all. The only change is
> changing /// to //!.
>
> Signed-off-by: Alice Ryhl <aliceryhl@xxxxxxxxxx>
> ---

Reviewed-by: Christian Schrefl <chrisi.schrefl@xxxxxxxxx>

Cheers
Christian