[pbs-devel] [PATCH proxmox 08/10] docs: remove empty lines in docs

Maximiliano Sandoval m.sandoval at proxmox.com
Tue Dec 3 11:20:36 CET 2024


Fixes the clippy lints:

```
warning: empty line after doc comment
  --> proxmox-lang/src/lib.rs:33:1
   |
33 | / /// ```
34 | |
   | |_
35 |   #[macro_export]
36 |   macro_rules! try_block {
   |   ---------------------- the comment documents this macro
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
   = note: `#[warn(clippy::empty_line_after_doc_comments)]` on by default
   = help: if the empty line is unintentional remove it

warning: empty line after doc comment
   --> proxmox-router/src/cli/mod.rs:308:5
    |
308 | /     /// Can be used multiple times.
309 | |
    | |_
310 |       /// Finish the command line interface.
311 |       pub fn build(self) -> CommandLineInterface {
    |       ------------------------------------------ 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: `#[warn(clippy::empty_line_after_doc_comments)]` on by default
    = help: if the empty line is unintentional remove it
help: if the documentation should include the empty line include it in the comment
    |
309 |     ///
    |
```

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 proxmox-lang/src/lib.rs       | 1 -
 proxmox-router/src/cli/mod.rs | 2 +-
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/proxmox-lang/src/lib.rs b/proxmox-lang/src/lib.rs
index cf191c0b..0abfd507 100644
--- a/proxmox-lang/src/lib.rs
+++ b/proxmox-lang/src/lib.rs
@@ -31,7 +31,6 @@ pub mod ops;
 /// })
 /// .map_err(|e| format_err!("my try block returned an error - {}", e));
 /// ```
-
 #[macro_export]
 macro_rules! try_block {
     { $($token:tt)* } => {{ (|| -> Result<_,_> { $($token)* })() }}
diff --git a/proxmox-router/src/cli/mod.rs b/proxmox-router/src/cli/mod.rs
index 2b5a69c8..2393da31 100644
--- a/proxmox-router/src/cli/mod.rs
+++ b/proxmox-router/src/cli/mod.rs
@@ -306,7 +306,7 @@ impl CliCommandMap {
     /// Builder style method to set extra options for the entire set of subcommands, taking a
     /// prepared `GlobalOptions` for potential
     /// Can be used multiple times.
-
+    ///
     /// Finish the command line interface.
     pub fn build(self) -> CommandLineInterface {
         self.into()
-- 
2.39.5





More information about the pbs-devel mailing list