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

[Maximiliano Sandoval]

Fabian Grünbichler <f.gruenbichler at 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