[pbs-devel] partially-applied: [PATCH backup 01/13] docs: remove redundant explicit link target

[Fabian Grünbichler]

applied all (sent ;)) patches except #8, see comment there.

On February 13, 2024 10:04 am, Maximiliano Sandoval wrote:
> 
> I somehow managed to not send the entire series, I'll send a new one 🙊.
> 
> Days since last email incident: 0.
> 
> Maximiliano Sandoval <m.sandoval at proxmox.com> writes:
> 
>> Fixes:
>>
>> ```
>> warning: redundant explicit link target
>>   --> src/tools/mod.rs:47:42
>>    |
>> 47 | /// Returns a new instance of [`Client`](proxmox_http::client::Client) configured for PBS usage.
>>    |                                --------  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ explicit target is redundant
>>    |                                |
>>    |                                because label contains path that resolves to same destination
>>    |
>>    = 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
>>    |
>> 47 | /// Returns a new instance of [`Client`] configured for PBS usage.
>>    |                               ~~~~~~~~~~
>> ```
>>
>> Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
>> ---
>>  pbs-config/src/acl.rs | 2 +-
>>  src/tools/mod.rs      | 2 +-
>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/pbs-config/src/acl.rs b/pbs-config/src/acl.rs
>> index 20269f5d..cd9987fa 100644
>> --- a/pbs-config/src/acl.rs
>> +++ b/pbs-config/src/acl.rs
>> @@ -198,7 +198,7 @@ impl AclTreeNode {
>>      }
>>
>>      /// Returns applicable [Role] and their propagation status for a given
>> -    /// [Authid](pbs_api_types::Authid).
>> +    /// [Authid].
>>      ///
>>      /// If the `Authid` is a [User](pbs_api_types::User) that has no specific `Roles` configured on
>>      /// this node, applicable `Group` roles will be returned instead.
>> diff --git a/src/tools/mod.rs b/src/tools/mod.rs
>> index b6cc5448..f8c4f2d5 100644
>> --- a/src/tools/mod.rs
>> +++ b/src/tools/mod.rs
>> @@ -44,7 +44,7 @@ pub fn detect_modified_configuration_file(
>>  pub const PROXMOX_BACKUP_TCP_KEEPALIVE_TIME: u32 = 120;
>>  pub const DEFAULT_USER_AGENT_STRING: &str = "proxmox-backup-client/1.0";
>>
>> -/// Returns a new instance of [`Client`](proxmox_http::client::Client) configured for PBS usage.
>> +/// Returns a new instance of [`Client`] configured for PBS usage.
>>  pub fn pbs_simple_http(proxy_config: Option<ProxyConfig>) -> Client {
>>      let options = HttpOptions {
>>          proxy_config,
> 
> 
> --
> Maximiliano
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel at lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
>