]> git.proxmox.com Git - proxmox-backup.git/commitdiff
docs: remove redundant explicit link target
authorMaximiliano Sandoval <m.sandoval@proxmox.com>
Mon, 12 Feb 2024 13:17:26 +0000 (14:17 +0100)
committerFabian Grünbichler <f.gruenbichler@proxmox.com>
Tue, 13 Feb 2024 09:01:51 +0000 (10:01 +0100)
Fixes:

```
warning: redundant explicit link target
  --> src/tools/mod.rs:47:42
   |
47 | /// Returns a new instance of [`Client`](proxmox_http::client::Client) configured for PBS usage.
   |                                --------  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant
   |                                |
   |                                because label contains path that resolves to same destination
   |
   = note: when a link's destination is not specified,
           the label is used to resolve intra-doc links
   = note: `#[warn(rustdoc::redundant_explicit_links)]` on by default
help: remove explicit link target
   |
47 | /// Returns a new instance of [`Client`] configured for PBS usage.
   |                               ~~~~~~~~~~
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
pbs-config/src/acl.rs
src/tools/mod.rs

index 20269f5db35c3562edf29fe02e1910604ef8fef5..cd9987fa6ed5b300426be9307949f8f524a7fcbe 100644 (file)
@@ -198,7 +198,7 @@ impl AclTreeNode {
     }
 
     /// Returns applicable [Role] and their propagation status for a given
-    /// [Authid](pbs_api_types::Authid).
+    /// [Authid].
     ///
     /// If the `Authid` is a [User](pbs_api_types::User) that has no specific `Roles` configured on
     /// this node, applicable `Group` roles will be returned instead.
index b6cc5448f18d1999c1d58c5bc38338e774c32f68..f8c4f2d58164bf4075214790a8714d827a5fb9fc 100644 (file)
@@ -44,7 +44,7 @@ pub fn detect_modified_configuration_file(
 pub const PROXMOX_BACKUP_TCP_KEEPALIVE_TIME: u32 = 120;
 pub const DEFAULT_USER_AGENT_STRING: &str = "proxmox-backup-client/1.0";
 
-/// Returns a new instance of [`Client`](proxmox_http::client::Client) configured for PBS usage.
+/// Returns a new instance of [`Client`] configured for PBS usage.
 pub fn pbs_simple_http(proxy_config: Option<ProxyConfig>) -> Client {
     let options = HttpOptions {
         proxy_config,