Proxmox-Port/proxmox
1
0
Fork 0
forked from proxmox-mirrors/proxmox
Code Pull Requests Activity

docs: remove empty lines in docs

Browse Source 
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@proxmox.com>
This commit is contained in:
Maximiliano Sandoval 2024-12-03 11:20:36 +01:00 committed by Fabian Grünbichler
parent 3f62a4dacf
commit c8d49a7d38
2 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
proxmox-lang/src/lib.rs
View File

@ -31,7 +31,6 @@ pub mod ops;
/// }) /// })
/// .map_err(|e| format_err!("my try block returned an error - {}", e)); /// .map_err(|e| format_err!("my try block returned an error - {}", e));
/// ``` /// ```
#[macro_export] #[macro_export]
macro_rules! try_block { macro_rules! try_block {
{ $($token:tt)* } => {{ (|| -> Result<_,_> { $($token)* })() }} { $($token:tt)* } => {{ (|| -> Result<_,_> { $($token)* })() }}

2
proxmox-router/src/cli/mod.rs
View File

@ -306,7 +306,7 @@ impl CliCommandMap {
/// Builder style method to set extra options for the entire set of subcommands, taking a /// Builder style method to set extra options for the entire set of subcommands, taking a
/// prepared `GlobalOptions` for potential /// prepared `GlobalOptions` for potential
/// Can be used multiple times. /// Can be used multiple times.
///
/// Finish the command line interface. /// Finish the command line interface.
pub fn build(self) -> CommandLineInterface { pub fn build(self) -> CommandLineInterface {
self.into() self.into()