[pbs-devel] [PATCH proxmox 06/10] ldap: docs: turn uri into link

Maximiliano Sandoval m.sandoval at proxmox.com
Wed Aug 7 09:43:52 CEST 2024


Fixes the following cargo doc warning:

warning: this URL is not a hyperlink
   --> proxmox-ldap/src/lib.rs:199:9
    |
199 |     /// https://www.rfc-editor.org/rfc/rfc4512#section-5.1
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://www.rfc-editor.org/rfc/rfc4512#section-5.1>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 proxmox-ldap/src/lib.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/proxmox-ldap/src/lib.rs b/proxmox-ldap/src/lib.rs
index 014bdcc1..4766f338 100644
--- a/proxmox-ldap/src/lib.rs
+++ b/proxmox-ldap/src/lib.rs
@@ -195,8 +195,9 @@ impl Connection {
         Ok(())
     }
 
-    /// Retrieves an attribute from the root DSE according to RFC 4512, Section 5.1
-    /// https://www.rfc-editor.org/rfc/rfc4512#section-5.1
+    /// Retrieves an attribute from the root DSE according to [RFC 4512], Section 5.1
+    ///
+    /// [RFC 4512]: https://www.rfc-editor.org/rfc/rfc4512#section-5.1
     pub async fn retrieve_root_dse_attr(&self, attr: &str) -> Result<Vec<String>, Error> {
         let mut ldap = self.create_connection().await?;
 
-- 
2.39.2





More information about the pbs-devel mailing list