Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix new clippy rule empty_line_after_doc_comments #505

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

yukiiiteru
Copy link
Member

@yukiiiteru yukiiiteru commented Sep 26, 2024

error: empty line after doc comment
  --> volo-thrift/src/codec/default/thrift.rs:37:5
   |
37 | /     /// This is unimplemented yet.
38 | |     // pub fn with_multiplex(mut self, multiplex: bool) -> Self {
39 | |     //     self.multiplex = multiplex;
40 | |     //     self
41 | |     // }
42 | |
   | |_
...
45 |       pub fn with_protocol(mut self, protocol: Protocol) -> Self {
   |       ---------------------------------------------------------- the comment documents this method
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
   = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
   = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
   = help: if the empty line is unintentional remove it
help: if the doc comment should not document `with_protocol` comment it out
   |
29 ~     // /// Whether to use thrift multiplex protocol.
30 ~     // ///
31 ~     // /// When the multiplexed protocol is used, the name contains the service name,
32 ~     // /// a colon : and the method name. The multiplexed protocol is not compatible
33 ~     // /// with other protocols.
34 ~     // ///
35 ~     // /// Spec: <https://github.com/apache/thrift/blob/master/doc/specs/thrift-rpc.md>
36 ~     // ///
37 ~     // /// This is unimplemented yet.
   |

error: could not compile `volo-thrift` (lib) due to 1 previous error

> error: empty line after doc comment
>   --> volo-thrift/src/codec/default/thrift.rs:37:5
>    |
> 37 | /     /// This is unimplemented yet.
> 38 | |     // pub fn with_multiplex(mut self, multiplex: bool) -> Self {
> 39 | |     //     self.multiplex = multiplex;
> 40 | |     //     self
> 41 | |     // }
> 42 | |
>    | |_
> ...
> 45 |       pub fn with_protocol(mut self, protocol: Protocol) -> Self {
>    |       ---------------------------------------------------------- the comment documents this method
>    |
>    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
>    = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
>    = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
>    = help: if the empty line is unintentional remove it
> help: if the doc comment should not document `with_protocol` comment it out
>    |
> 29 ~     // /// Whether to use thrift multiplex protocol.
> 30 ~     // ///
> 31 ~     // /// When the multiplexed protocol is used, the name contains the service name,
> 32 ~     // /// a colon : and the method name. The multiplexed protocol is not compatible
> 33 ~     // /// with other protocols.
> 34 ~     // ///
> 35 ~     // /// Spec: <https://github.com/apache/thrift/blob/master/doc/specs/thrift-rpc.md>
> 36 ~     // ///
> 37 ~     // /// This is unimplemented yet.
>    |
>
> error: could not compile `volo-thrift` (lib) due to 1 previous error

Signed-off-by: Yu Li <[email protected]>
@yukiiiteru yukiiiteru requested review from a team as code owners September 26, 2024 13:01
PureWhiteWu
PureWhiteWu previously approved these changes Sep 26, 2024
Millione
Millione previously approved these changes Sep 26, 2024
@yukiiiteru yukiiiteru dismissed stale reviews from Millione and PureWhiteWu via cd84286 September 26, 2024 13:19
@yukiiiteru yukiiiteru changed the title chore(ci): adjust order of toolchains in CI chore: fix new clippy rule empty_line_after_doc_comments Sep 26, 2024
@yukiiiteru
Copy link
Member Author

Currently, all errors are from rust-lang/rust-clippy#13458, which is a bug in clippy and can be ignored for now.

@yukiiiteru yukiiiteru merged commit 75f2922 into cloudwego:main Sep 26, 2024
6 of 14 checks passed
@yukiiiteru yukiiiteru deleted the ci-order branch September 26, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants