rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Yutaro Ohno <yutaro.ono.418@gmail.com>
To: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Cc: "Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Wedson Almeida Filho" <wedsonaf@gmail.com>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <benno.lossin@proton.me>,
	"Andreas Hindborg" <a.hindborg@samsung.com>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Martin Rodriguez Reboredo" <yakoyoku@gmail.com>,
	"Aswin Unnikrishnan" <aswinunni01@gmail.com>,
	"FUJITA Tomonori" <fujita.tomonori@gmail.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	rust-for-linux@vger.kernel.org
Subject: Re: [PATCH] rust: macros: fix indentation in `module!`'s doc comment
Date: Tue, 13 Aug 2024 22:22:17 +0900	[thread overview]
Message-ID: <ZrteCUcz7eT_7TSY@ohnotp> (raw)
In-Reply-To: <CANiq72=Psp2vyQEf=MQfN61Xqe4UXT08Y=YeOgV_0LLEzTGfRA@mail.gmail.com>

On 08/13, Miguel Ojeda wrote:
> On Tue, Aug 13, 2024 at 3:09 PM Yutaro Ohno <yutaro.ono.418@gmail.com> wrote:
> >
> > Clippy warns about list content in a doc comment that doesn't have extra
> > spaces at the beginning of a new line [1], like this:
> >
> > ```rust
> > /// * Do nothing.
> > /// * Then do something. Whatever it is needs done,
> > /// it should be done right now.
> > ```
> >
> > The suggested format is:
> >
> > ```rust
> > /// * Do nothing.
> > /// * Then do something. Whatever it is needs done,
> > ///   it should be done right now.
> > ```
> >
> > This commit adds extra indentation to the `module!`'s doc comment to
> > suppress the warning.
> >
> > Link: https://rust-lang.github.io/rust-clippy/master/index.html#/doc_lazy_continuation [1]
> > Signed-off-by: Yutaro Ohno <yutaro.ono.418@gmail.com>
> 
> Thanks Yutaro -- this was fixed already in the `rust-fixes` branch,
> which is going to Linus soon.
> 
> Nevertheless, the patch looks good to me, and it has a nice commit message! :)
> 
> Cheers,
> Miguel

Oh, I see. Thank you for letting me know!

Thanks,
Yutaro

  reply	other threads:[~2024-08-13 13:22 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-13 13:09 [PATCH] rust: macros: fix indentation in `module!`'s doc comment Yutaro Ohno
2024-08-13 13:14 ` Miguel Ojeda
2024-08-13 13:22   ` Yutaro Ohno [this message]
2024-08-14  6:08   ` Additional patches for rust-fixes? (was: Re: [PATCH] rust: macros: fix indentation in `module!`'s doc comment) Dirk Behme
2024-08-14 10:46     ` Miguel Ojeda

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZrteCUcz7eT_7TSY@ohnotp \
    --to=yutaro.ono.418@gmail.com \
    --cc=a.hindborg@samsung.com \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=aswinunni01@gmail.com \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=fujita.tomonori@gmail.com \
    --cc=gary@garyguo.net \
    --cc=miguel.ojeda.sandonis@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    --cc=wedsonaf@gmail.com \
    --cc=yakoyoku@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).