mirror of
https://git.proxmox.com/git/proxmox
synced 2025-08-03 01:10:28 +00:00
api-types: doc: add crate to Display
trait in comments
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> Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
parent
57fa204064
commit
214317df93
@ -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);
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user