Re: [PATCH 08/19] rust: enable `rustdoc::unescaped_backticks` lint
From: Alice Ryhl
Date: Thu Sep 05 2024 - 04:13:51 EST
On Wed, Sep 4, 2024 at 10:45 PM Miguel Ojeda <ojeda@xxxxxxxxxx> wrote:
>
> In Rust 1.71.0, `rustdoc` added the `unescaped_backticks` lint, which
> detects what are typically typos in Markdown formatting regarding inline
> code [1], e.g. from the Rust standard library:
>
> /// ... to `deref`/`deref_mut`` must ...
>
> /// ... use [`from_mut`]`. Specifically, ...
>
> It does not seem to have almost any false positives, from the experience
> of enabling it in the Rust standard library [2], which will be checked
> starting with Rust 1.82.0. The maintainers also confirmed it is ready
> to be used.
>
> Thus enable it.
>
> Link: https://doc.rust-lang.org/rustdoc/lints.html#unescaped_backticks [1]
> Link: https://github.com/rust-lang/rust/pull/128307 [2]
> Signed-off-by: Miguel Ojeda <ojeda@xxxxxxxxxx>
Reviewed-by: Alice Ryhl <aliceryhl@xxxxxxxxxx>