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>
This commit is contained in:
Maximiliano Sandoval 2024-08-07 09:43:53 +02:00 committed by Thomas Lamprecht
parent f80cb33993
commit 2794c137d5

View File

@ -32,7 +32,7 @@ pub struct CreateTicket {
pub privs: Option<String>, pub privs: Option<String>,
/// You can optionally pass the realm using this parameter. Normally the /// 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")] #[serde(default, skip_serializing_if = "Option::is_none")]
pub realm: Option<String>, pub realm: Option<String>,