[pbs-devel] [PATCH proxmox 03/10] docs: clippy: add indentation to doc list items

Maximiliano Sandoval m.sandoval at proxmox.com
Wed Aug 7 09:43:49 CEST 2024


Fixes the clippy warning:

warning: doc list item missing indentation
   --> proxmox-subscription/src/subscription_info.rs:179:9
    |
179 |     ///  (this mode is used to decide whether to refresh the subscription information)
    |         ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
179 |     ///   (this mode is used to decide whether to refresh the subscription information)
    |          +

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 proxmox-auth-api/src/types.rs                 | 2 +-
 proxmox-rest-server/src/worker_task.rs        | 2 +-
 proxmox-subscription/src/subscription_info.rs | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/proxmox-auth-api/src/types.rs b/proxmox-auth-api/src/types.rs
index 21136824..25e5feff 100644
--- a/proxmox-auth-api/src/types.rs
+++ b/proxmox-auth-api/src/types.rs
@@ -14,7 +14,7 @@
 //! * [`TokennameRef`]: a borrowed `Tokenname` (`str` equivalent).
 //! * [`Userid`]: an owned user id (`"user at realm"`).
 //! * [`Authid`]: an owned Authentication ID (a `Userid` with an optional `Tokenname`).
-//! Note that `Userid` and `Authid` do not have a separate borrowed type.
+//!   Note that `Userid` and `Authid` do not have a separate borrowed type.
 //!
 //! Note that `Username`s are not unique, therefore they do not implement `Eq` and cannot be
 //! compared directly. If a direct comparison is really required, they can be compared as strings
diff --git a/proxmox-rest-server/src/worker_task.rs b/proxmox-rest-server/src/worker_task.rs
index 8691748e..62e5893f 100644
--- a/proxmox-rest-server/src/worker_task.rs
+++ b/proxmox-rest-server/src/worker_task.rs
@@ -553,7 +553,7 @@ pub fn worker_is_active_local(upid: &UPID) -> bool {
 /// * ``worker-task-abort <UPID>``: calls [abort_local_worker]
 ///
 /// * ``worker-task-status <UPID>``: return true of false, depending on
-/// whether the worker is running or stopped.
+///   whether the worker is running or stopped.
 pub fn register_task_control_commands(commando_sock: &mut CommandSocket) -> Result<(), Error> {
     fn get_upid(args: Option<&Value>) -> Result<UPID, Error> {
         let args = if let Some(args) = args {
diff --git a/proxmox-subscription/src/subscription_info.rs b/proxmox-subscription/src/subscription_info.rs
index ae40dbff..a86572d0 100644
--- a/proxmox-subscription/src/subscription_info.rs
+++ b/proxmox-subscription/src/subscription_info.rs
@@ -176,7 +176,7 @@ impl SubscriptionInfo {
     /// - Signed instances are valid for up to a year, clamped by the next due date
     /// - Unsigned instances are valid for 30+5 days
     /// - If `recheck` is set to `true`, unsigned instances are only treated as valid for 5 days
-    ///  (this mode is used to decide whether to refresh the subscription information)
+    ///   (this mode is used to decide whether to refresh the subscription information)
     ///
     /// If the criteria are not met, `status` is set to [SubscriptionStatus::Invalid] and `message`
     /// to a human-readable error message.
-- 
2.39.2





More information about the pbs-devel mailing list