[pbs-devel] [PATCH proxmox 07/10] login: docs: fix typo and add escape html tags
Maximiliano Sandoval
m.sandoval at proxmox.com
Wed Aug 7 09:43:53 CEST 2024
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 at 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>,
--
2.39.2
More information about the pbs-devel
mailing list