From c17964e7fc45dfe54fadb7915724fb501cdc5c71 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fabian=20Gr=C3=BCnbichler?= <f.gruenbichler@proxmox.com>
Date: Tue, 3 Dec 2024 11:52:00 +0100
Subject: [PATCH] docs: escape <foo> in doc comments
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

warning: unclosed HTML tag `nodename`
   --> pbs-api-types/src/metrics.rs:224:5
    |
224 | /     /// Unique identifier for this metric object, for instance 'node/<nodename>'
225 | |     /// or 'qemu/<vmid>'.
    | |_________________________^
    |
    = note: `#[warn(rustdoc::invalid_html_tags)]` on by default

warning: unclosed HTML tag `vmid`
   --> pbs-api-types/src/metrics.rs:224:5
    |
224 | /     /// Unique identifier for this metric object, for instance 'node/<nodename>'
225 | |     /// or 'qemu/<vmid>'.
    | |_________________________^

warning: `pbs-api-types` (lib doc) generated 2 warnings

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
---
 pbs-api-types/src/metrics.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/pbs-api-types/src/metrics.rs b/pbs-api-types/src/metrics.rs
index 26266529..014e28e4 100644
--- a/pbs-api-types/src/metrics.rs
+++ b/pbs-api-types/src/metrics.rs
@@ -221,8 +221,8 @@ pub struct Metrics {
 /// Metric data point
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct MetricDataPoint {
-    /// Unique identifier for this metric object, for instance 'node/<nodename>'
-    /// or 'qemu/<vmid>'.
+    /// Unique identifier for this metric object, for instance `node/<nodename>`
+    /// or `qemu/<vmid>`.
     pub id: String,
 
     /// Name of the metric.