Re: [PATCH v2] docs: rust: fix formatting for kernel::block::mq::Request

From: Miguel Ojeda
Date: Tue Oct 22 2024 - 18:31:56 EST


On Tue, Sep 3, 2024 at 8:00 PM Francesco Zardi <frazar00@xxxxxxxxx> wrote:
>
> Fix several issues with rustdoc formatting for the
> `kernel::block::mq::Request` module, in particular:
>
> - An ordered list not rendering correctly, fixed by using numbers prefixes
> instead of letters
>
> - Code snippets formatted as regular text, fixed by wrapping the code with
> `back-ticks`
>
> - References to types missing intra-doc links, fixed by wrapping the
> types with [square brackets]
>
> Reported-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1108
> Signed-off-by: Francesco Zardi <frazar00@xxxxxxxxx>

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

[ Added an extra intra-doc link. Took the chance to add some periods
for consistency. Reworded slightly. - Miguel ]

Cheers,
Miguel