From 2794c137d54def433d9fccffbd7e1cbb22a7f137 Mon Sep 17 00:00:00 2001
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
Date: Wed, 7 Aug 2024 09:43:53 +0200
Subject: [PATCH] login: docs: fix typo and add escape html tags

Fixes the cargo docs warning:

warning: unclosed HTML tag `username`
  --> proxmox-login/src/api.rs:35:47
   |
35 |     /// realm is simply added to the username <username>@<relam>.
   |                                               ^^^^^^^^^^
   |
   = note: `#[warn(rustdoc::invalid_html_tags)]` on by default

warning: unclosed HTML tag `relam`
  --> proxmox-login/src/api.rs:35:58
   |
35 |     /// realm is simply added to the username <username>@<relam>.
   |                                                          ^^^^^^^

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
Reviewed-by: Lukas Wagner <l.wagner@proxmox.com>
---
 proxmox-login/src/api.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/proxmox-login/src/api.rs b/proxmox-login/src/api.rs
index 44232b6f..aa8575fe 100644
--- a/proxmox-login/src/api.rs
+++ b/proxmox-login/src/api.rs
@@ -32,7 +32,7 @@ pub struct CreateTicket {
     pub privs: Option<String>,
 
     /// You can optionally pass the realm using this parameter. Normally the
-    /// realm is simply added to the username <username>@<relam>.
+    /// realm is simply added to the username `<username>@<realm>`.
     #[serde(default, skip_serializing_if = "Option::is_none")]
     pub realm: Option<String>,