doc: update documentation of catalog.load_by_id

2025-11-11 11:13:01 +01:00
parent 25a39ce54c
commit 5a15a018ab
1 changed files with 5 additions and 0 deletions
--- a/01.workspace/heave/src/imp/catalog_load_by_id.rs
+++ b/01.workspace/heave/src/imp/catalog_load_by_id.rs
@@ -20,6 +20,11 @@ impl Catalog {
    /// # Arguments
    ///
    /// * `id` - The ID of the entity to load.
+    ///
+    /// # Errors
+    ///
+    /// Returns `Err(FailedTo::LoadFromDB)` if there is an issue loading the entity
+    /// from the database.
    pub fn load_by_id(&mut self, id: &str) -> Result<(), FailedTo> {
        let path = path::Path::new(&self.path);
        self.on_items(|items| {