[pbs-devel] [PATCH proxmox 05/10] client: docs: remove redundant link

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


Fixes the cargo doc warnings:

warning: redundant explicit link target
 --> proxmox-http/src/client/mod.rs:4:19
  |
4 | //! in [`Client`](crate::client::Client).
  |         --------  ^^^^^^^^^^^^^^^^^^^^^ 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
  |
4 | //! in [`Client`].
  |        ~~~~~~~~~~

warning: redundant explicit link target
 --> proxmox-http/src/client/mod.rs:7:22
  |
7 | //! [`sync::Client`](crate::client::sync::Client).
  |      --------------  ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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
help: remove explicit link target
  |
7 | //! [`sync::Client`].
  |     ~~~~~~~~~~~~~~~~

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 proxmox-http/src/client/mod.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/proxmox-http/src/client/mod.rs b/proxmox-http/src/client/mod.rs
index 2b638605..eb694518 100644
--- a/proxmox-http/src/client/mod.rs
+++ b/proxmox-http/src/client/mod.rs
@@ -1,10 +1,10 @@
 //! Simple TLS capable HTTP client implementations.
 //!
 //! Feature `client` contains a lightweight wrapper around `hyper` with support for TLS connections
-//! in [`Client`](crate::client::Client).
+//! in [`Client`].
 //!
 //! Feature `client-sync` contains a lightweight wrapper around `ureq` in
-//! [`sync::Client`](crate::client::sync::Client).
+//! [`sync::Client`].
 //!
 //! Both clients implement [`HttpClient`](crate::HttpClient) if the feature `client-trait` is enabled.
 
-- 
2.39.2





More information about the pbs-devel mailing list