public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox 03/10] docs: clippy: add indentation to doc list items
Date: Wed,  7 Aug 2024 09:43:49 +0200	[thread overview]
Message-ID: <20240807074356.83378-3-m.sandoval@proxmox.com> (raw)
In-Reply-To: <20240807074356.83378-1-m.sandoval@proxmox.com>

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@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@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



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2024-08-07  7:44 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-07  7:43 [pbs-devel] [PATCH proxmox 01/10] clippy: remove needless borrow Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 02/10] apt: clippy: don't clone types implementing Copy Maximiliano Sandoval
2024-08-07  7:43 ` Maximiliano Sandoval [this message]
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 04/10] property_string: clippy: define bound once Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 05/10] client: docs: remove redundant link Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 06/10] ldap: docs: turn uri into link Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 07/10] login: docs: fix typo and add escape html tags Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 08/10] serde: docs: " Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 09/10] server: docs: fix unresolved link to systemd_notify Maximiliano Sandoval
2024-08-07  7:43 ` [pbs-devel] [PATCH proxmox 10/10] auth-api: docs: remove wrong return info Maximiliano Sandoval
2024-08-07  9:32 ` [pbs-devel] [PATCH proxmox 01/10] clippy: remove needless borrow Lukas Wagner
2024-08-07 18:59 ` [pbs-devel] applied-series: " Thomas Lamprecht
2024-08-09 11:11   ` Maximiliano Sandoval

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=20240807074356.83378-3-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal