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

[Benno Lossin]

On Thu Mar 13, 2025 at 9:52 AM CET, 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>

Good catch! I think this should have a fixes tag:

    Fixes: 8d9b095b8f89 ("samples: rust_misc_device: Provide an example C program to exercise functionality")

Reviewed-by: Benno Lossin <benno.lossin@xxxxxxxxx>

---
Cheers,
Benno

> ---
>  samples/rust/rust_misc_device.rs | 181 ++++++++++++++++++++-------------------
>  1 file changed, 91 insertions(+), 90 deletions(-)