From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox 08/10] docs: remove empty lines in docs
Date: Tue, 3 Dec 2024 11:20:36 +0100 [thread overview]
Message-ID: <20241203102038.166031-8-m.sandoval@proxmox.com> (raw)
In-Reply-To: <20241203102038.166031-1-m.sandoval@proxmox.com>
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>
---
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
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-12-03 10:21 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-03 10:20 [pbs-devel] [PATCH proxmox 01/10] apt: file: Use unwrap_or_default instead of match Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 02/10] api: webhook: doc: add indentation to list item Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 03/10] apt: repositories: use if-let instead of match for Option Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 04/10] router: parsing: docs: fix Records::from link Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 05/10] router: parsing: docs: fix 'instead' typo Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 06/10] elide lifetimes where possible Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 07/10] remove unnecessary return statement Maximiliano Sandoval
2024-12-03 10:20 ` Maximiliano Sandoval [this message]
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 09/10] sys: systemd: remove empty line after outer attribute Maximiliano Sandoval
2024-12-03 10:20 ` [pbs-devel] [PATCH proxmox 10/10] apt: repositories: remove unnecessary if-let in iterator Maximiliano Sandoval
2024-12-03 13:30 ` [pbs-devel] applied-seires: " Fabian Grünbichler
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=20241203102038.166031-8-m.sandoval@proxmox.com \
--to=m.sandoval@proxmox.com \
--cc=pbs-devel@lists.proxmox.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