[pbs-devel] [PATCH proxmox-backup] api-types: doc: add crate to `Display` trait in comments

[pbs-devel] [PATCH proxmox-backup] api-types: doc: add crate to `Display` trait in comments

[Stefan Sterz]

when creating the documentation (e.g. `cargo doc --open`), it would
warn that `Display` is not in scope.

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
---
 pbs-api-types/src/datastore.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index 86201b8e..70b639ea 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -579,7 +579,7 @@ impl BackupNamespace {
         Ok(())
     }
 
-    /// Return an adapter which [`Display`]s as a path with `"ns/"` prefixes in front of every
+    /// Return an adapter which [`fmt::Display`]s as a path with `"ns/"` prefixes in front of every
     /// component.
     pub fn display_as_path(&self) -> BackupNamespacePath {
         BackupNamespacePath(self)
@@ -691,7 +691,7 @@ impl ApiType for BackupNamespace {
 
 /// Helper to format a [`BackupNamespace`] as a path component of a [`BackupGroup`].
 ///
-/// This implements [`Display`] such that it includes the `ns/` subdirectory prefix in front of
+/// This implements [`fmt::Display`] such that it includes the `ns/` subdirectory prefix in front of
 /// every component.
 pub struct BackupNamespacePath<'a>(&'a BackupNamespace);
 
-- 
2.30.2

[pbs-devel] applied: [PATCH proxmox-backup] api-types: doc: add crate to `Display` trait in comments

[Wolfgang Bumiller]

applied, thanks

On Wed, Jun 29, 2022 at 10:55:38AM +0200, Stefan Sterz wrote:
> when creating the documentation (e.g. `cargo doc --open`), it would
> warn that `Display` is not in scope.
> 
> Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
> ---
>  pbs-api-types/src/datastore.rs | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
> index 86201b8e..70b639ea 100644
> --- a/pbs-api-types/src/datastore.rs
> +++ b/pbs-api-types/src/datastore.rs
> @@ -579,7 +579,7 @@ impl BackupNamespace {
>          Ok(())
>      }
>  
> -    /// Return an adapter which [`Display`]s as a path with `"ns/"` prefixes in front of every
> +    /// Return an adapter which [`fmt::Display`]s as a path with `"ns/"` prefixes in front of every
>      /// component.
>      pub fn display_as_path(&self) -> BackupNamespacePath {
>          BackupNamespacePath(self)
> @@ -691,7 +691,7 @@ impl ApiType for BackupNamespace {
>  
>  /// Helper to format a [`BackupNamespace`] as a path component of a [`BackupGroup`].
>  ///
> -/// This implements [`Display`] such that it includes the `ns/` subdirectory prefix in front of
> +/// This implements [`fmt::Display`] such that it includes the `ns/` subdirectory prefix in front of
>  /// every component.
>  pub struct BackupNamespacePath<'a>(&'a BackupNamespace);
>  
> -- 
> 2.30.2