rust: document used_disk_space

openSUSE · Mar 4, 2024 · ab55a05 · ab55a05
1 parent 6d6ee2d
commit ab55a05
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/rust/agama-lib/src/software/client.rs b/rust/agama-lib/src/software/client.rs
@@ -112,6 +112,9 @@ impl<'a> SoftwareClient<'a> {
         }
     }
 
+    /// Returns the required space for installing the selected patterns.
+    ///
+    /// It returns a formatted string including the size and the unit.
     pub async fn used_disk_space(&self) -> Result<String, ServiceError> {
         Ok(self.software_proxy.used_disk_space().await?)
     }