[pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct

Maximiliano Sandoval m.sandoval at proxmox.com
Tue Dec 3 10:32:41 CET 2024


Fixes:

```
warning: public documentation for `PxarExtractContext` links to private item `ExtractorIter`
   --> pbs-client/src/pxar/extract.rs:404:27
    |
404 | /// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
    |                           ^^^^^^^^^^^^^ this item is private
    |
    = note: this link will resolve properly if you pass `--document-private-items`
    = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
```

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 pbs-client/src/pxar/extract.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs
index cfbd8d51..c31e1be8 100644
--- a/pbs-client/src/pxar/extract.rs
+++ b/pbs-client/src/pxar/extract.rs
@@ -401,7 +401,7 @@ where
 }
 
 /// Provides additional [context][C] for [`anyhow::Error`]s that are returned
-/// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
+/// while traversing an ExtractorIter. The [`PxarExtractContext`] can then
 /// be accessed [via `anyhow`'s facilities][A] and may aid during error handling.
 ///
 ///
-- 
2.39.5





More information about the pbs-devel mailing list