[pdm-devel] [PATCH datacenter-manager 3/8] pdm-api-types: remote upid: add missing doc strings

[Lukas Wagner <l.wagner@proxmox.com>]

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 lib/pdm-api-types/src/remote_upid.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lib/pdm-api-types/src/remote_upid.rs b/lib/pdm-api-types/src/remote_upid.rs
index 6b0f8461..b4a32769 100644
--- a/lib/pdm-api-types/src/remote_upid.rs
+++ b/lib/pdm-api-types/src/remote_upid.rs
@@ -10,17 +10,20 @@ pub const REMOTE_UPID_SCHEMA: Schema = StringSchema::new("A remote UPID")
     .schema();
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash)]
+/// A UPID type for tasks on a specific remote.
 pub struct RemoteUpid {
     remote: String,
-    /// This is usually a pve upid, but may also be a pbs upid, they have distinct formats.
+    // This can either be a PVE UPID or a PBS UPID, both have distinct, incompatible formats.
     upid: String,
 }
 
 impl RemoteUpid {
+    /// Get the remote for this UPID.
     pub fn remote(&self) -> &str {
         &self.remote
     }
 
+    /// Get the remote for this UPID, consuming self.
     pub fn into_remote(self) -> String {
         self.remote
     }
-- 
2.47.3



_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel