From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Subject: Re: [pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct
Date: Tue, 03 Dec 2024 14:44:09 +0100 [thread overview]
Message-ID: <s8ocyi8ev9y.fsf@proxmox.com> (raw)
In-Reply-To: <1733229766.jd18gikqep.astroid@yuna.none> ("Fabian =?utf-8?Q?Gr=C3=BCnbichler=22's?= message of "Tue, 03 Dec 2024 13:43:17 +0100")
Fabian Grünbichler <f.gruenbichler@proxmox.com> writes:
> On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
>> 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
>> ```
>
> we have lots of private/internal stuff that is documented though, should
> we maybe look for a way to set that flag always?
Makes sense to me to use that flag, at least for rustdoc.proxmox.com.
--
Maximiliano
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
prev parent reply other threads:[~2024-12-03 13:44 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-03 9:32 Maximiliano Sandoval
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 [this message]
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=s8ocyi8ev9y.fsf@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal