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 08/10] serde: docs: escape html tags
Date: Wed,  7 Aug 2024 09:43:54 +0200	[thread overview]
Message-ID: <20240807074356.83378-8-m.sandoval@proxmox.com> (raw)
In-Reply-To: <20240807074356.83378-1-m.sandoval@proxmox.com>

Fixes the cargo docs warning:

warning: unclosed HTML tag `u8`
  --> proxmox-serde/src/lib.rs:55:18
   |
55 | /// Serialize Vec<u8> as base64 encoded string.
   |                  ^^^^
   |
   = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
help: try marking as source code
   |
55 | /// Serialize `Vec<u8>` as base64 encoded string.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 proxmox-serde/src/lib.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/proxmox-serde/src/lib.rs b/proxmox-serde/src/lib.rs
index 88986698..c1628349 100644
--- a/proxmox-serde/src/lib.rs
+++ b/proxmox-serde/src/lib.rs
@@ -52,7 +52,7 @@ pub mod epoch_as_rfc3339 {
     }
 }
 
-/// Serialize Vec<u8> as base64 encoded string.
+/// Serialize `Vec<u8>` as base64 encoded string.
 ///
 /// Usage example:
 /// ```
-- 
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 ` [pbs-devel] [PATCH proxmox 03/10] docs: clippy: add indentation to doc list items Maximiliano Sandoval
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 ` Maximiliano Sandoval [this message]
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-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal