From f55a08891e5de2321edb6108f24f8842e3a14b7a Mon Sep 17 00:00:00 2001 From: Maximiliano Sandoval Date: Tue, 3 Dec 2024 14:41:37 +0100 Subject: [PATCH] pxar: extract: docs: remove redundant explicit link Also fix `Entries` link. Fixes the cargo doc lint: ``` warning: redundant explicit link target --> pbs-client/src/pxar/extract.rs:212:27 | 212 | /// * The [`Entry`][E]'s filename is invalid (contains nul bytes or a slash) | ------- ^ explicit target is redundant | | | because label contains path that resolves to same destination | note: referenced explicit link target defined here --> pbs-client/src/pxar/extract.rs:221:14 | 221 | /// [E]: pxar::Entry | ^^^^^^^^^^^ = 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 | 212 | /// * The [`Entry`]'s filename is invalid (contains nul bytes or a slash) | ~~~~~~~~~ warning: redundant explicit link target --> pbs-client/src/pxar/extract.rs:215:37 | 215 | /// fetching the next [`Entry`][E]), the error may be handled by the | ------- ^ explicit target is redundant | | | because label contains path that resolves to same destination | note: referenced explicit link target defined here --> pbs-client/src/pxar/extract.rs:221:14 | 221 | /// [E]: pxar::Entry | ^^^^^^^^^^^ = note: when a link's destination is not specified, the label is used to resolve intra-doc links help: remove explicit link target | 215 | /// fetching the next [`Entry`]), the error may be handled by the ``` Signed-off-by: Maximiliano Sandoval --- pbs-client/src/pxar/extract.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs index cfbd8d51..48e3aef4 100644 --- a/pbs-client/src/pxar/extract.rs +++ b/pbs-client/src/pxar/extract.rs @@ -202,23 +202,22 @@ where { type Item = Result<(), Error>; - /// Performs the extraction of [`Entries`][E] yielded by the [`Decoder`][D]. + /// Performs the extraction of [`Entries`][Entry] yielded by the [`Decoder`][D]. /// /// In detail, the [`ExtractorIter`] will stop if and only if one of the /// following conditions is true: /// * The [`Decoder`][D] is exhausted /// * The [`Decoder`][D] failed to read from the archive and consequently /// yielded an [`io::Error`] - /// * The [`Entry`][E]'s filename is invalid (contains nul bytes or a slash) + /// * The [`Entry`]'s filename is invalid (contains nul bytes or a slash) /// /// Should an error occur during any point of extraction (**not** while - /// fetching the next [`Entry`][E]), the error may be handled by the + /// fetching the next [`Entry`]), the error may be handled by the /// [`ErrorHandler`] provided by the [`PxarExtractOptions`] used to /// initialize the iterator. /// /// Extraction errors will have a corresponding [`PxarExtractContext`] attached. /// - /// [E]: pxar::Entry /// [D]: pxar::decoder::Decoder fn next(&mut self) -> Option { if self.state.end_reached {