Re: [PATCH libgpiod 2/3] bindings: rust: libgpiod: turn standalone doc comment into normal comment

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Jan 2, 2025 at 8:41 AM Erik Schilling <erik.schilling@xxxxxxxxxx> wrote:
>
> This was complained about by clippy:
>
>     warning: empty line after doc comment
>        --> libgpiod/src/lib.rs:461:1
>         |
>     461 | / /// Various libgpiod-related functions.
>     462 | |
>         | |_
>     ...
>     467 |   pub fn is_gpiochip_device<P: AsRef<Path>>(path: &P) -> bool {
>         |   ----------------------------------------------------------- the comment documents this function
>         |
>         = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
>         = help: if the empty line is unintentional remove it
>     help: if the documentation should include the empty line include it in the comment
>         |
>     462 | ///
>         |
>
> The comment more seems to be of structural matter and should not be tied
> to the function immediately below it. So lets turn it into a normal
> non-doc comment.
> ---

Hey, commits are missing signed-offs.

Bart





[Index of Archives]     [Linux SPI]     [Linux Kernel]     [Linux ARM (vger)]     [Linux ARM MSM]     [Linux Omap]     [Linux Arm]     [Linux Tegra]     [Fedora ARM]     [Linux for Samsung SOC]     [eCos]     [Linux Fastboot]     [Gcc Help]     [Git]     [DCCP]     [IETF Announce]     [Security]     [Linux MIPS]     [Yosemite Campsites]

  Powered by Linux