[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <E3504594-6CD3-4D12-B0DA-92B032CD73AA@kloenk.dev>
Date: Thu, 04 Jul 2024 16:25:58 +0200
From: Finn Behrens <me@...enk.dev>
To: Miguel Ojeda <ojeda@...nel.org>
Cc: Wedson Almeida Filho <wedsonaf@...il.com>,
Alex Gaynor <alex.gaynor@...il.com>, Boqun Feng <boqun.feng@...il.com>,
Gary Guo <gary@...yguo.net>,
Björn Roy Baron <bjorn3_gh@...tonmail.com>,
Benno Lossin <benno.lossin@...ton.me>,
Andreas Hindborg <a.hindborg@...sung.com>, Alice Ryhl <aliceryhl@...gle.com>,
rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
patches@...ts.linux.dev
Subject: Re: [PATCH 01/13] rust: macros: indent list item in `paste!`'s docs
On 1 Jul 2024, at 20:36, Miguel Ojeda wrote:
> A new style lint, `doc_lazy_continuation` [1], has been introduced in the
> upcoming Rust 1.80 (currently in beta), which detects missing indentation
> in code documentation.
>
> We have one such case:
>
> error: doc list item missing indentation
> --> rust/macros/lib.rs:315:5
> |
> 315 | /// default the span of the `[< >]` group is used.
> | ^
> |
> = help: if this is supposed to be its own paragraph, add a blank line
> = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
> = note: `-D clippy::doc-lazy-continuation` implied by `-D clippy::style`
> = help: to override `-D clippy::style` add `#[allow(clippy::doc_lazy_continuation)]`
> help: indent this line
> |
> 315 | /// default the span of the `[< >]` group is used.
> | ++
>
> While the rendering of the docs by `rustdoc` is not affected, we apply
> this kind of indentation elsewhere since it looks better.
>
> Thus clean it up.
>
> Link: https://rust-lang.github.io/rust-clippy/master/index.html#/doc_lazy_continuation [1]
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
Reviewed-by: Finn Behrens <me@...enk.dev>
> ---
> rust/macros/lib.rs | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
> index 520eae5fd792..05d976b3c09a 100644
> --- a/rust/macros/lib.rs
> +++ b/rust/macros/lib.rs
> @@ -312,7 +312,7 @@ pub fn pinned_drop(args: TokenStream, input: TokenStream) -> TokenStream {
> ///
> /// Currently supported modifiers are:
> /// * `span`: change the span of concatenated identifier to the span of the specified token. By
> -/// default the span of the `[< >]` group is used.
> +/// default the span of the `[< >]` group is used.
> /// * `lower`: change the identifier to lower case.
> /// * `upper`: change the identifier to upper case.
> ///
> --
> 2.45.2
Powered by blists - more mailing lists