From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct
Date: Tue, 3 Dec 2024 10:32:41 +0100 [thread overview]
Message-ID: <20241203093243.97764-1-m.sandoval@proxmox.com> (raw)
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@proxmox.com>
---
| 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--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
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next reply other threads:[~2024-12-03 9:32 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-03 9:32 Maximiliano Sandoval [this message]
2024-12-03 9:32 ` [pbs-devel] [PATCH backup 2/3] config: acl: docs: link to PRIVILEGES with namespace Maximiliano Sandoval
2024-12-03 12:34 ` [pbs-devel] applied: " Fabian Grünbichler
2024-12-03 9:32 ` [pbs-devel] [PATCH backup 3/3] restore: docs: escape <uid> with code block Maximiliano Sandoval
2024-12-03 12:34 ` [pbs-devel] applied: " Fabian Grünbichler
2024-12-03 13:43 ` Maximiliano Sandoval
2024-12-03 12:43 ` [pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct Fabian Grünbichler
2024-12-03 13:44 ` Maximiliano Sandoval
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241203093243.97764-1-m.sandoval@proxmox.com \
--to=m.sandoval@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox