diff --git a/01.workspace/heave/src/imp/catalog_persist.rs b/01.workspace/heave/src/imp/catalog_persist.rs index 069f321..c8b2895 100644 --- a/01.workspace/heave/src/imp/catalog_persist.rs +++ b/01.workspace/heave/src/imp/catalog_persist.rs @@ -18,6 +18,11 @@ impl Catalog { /// removed from the in-memory catalog. /// - All other entities that were successfully persisted (new or updated) have /// their state changed to `EntityState::Loaded`. + /// + /// # Errors + /// + /// Returns `Err(FailedTo::PersistCatalog)` if there is an issue writing the + /// changes to the database. pub fn persist(&self) -> result::Result<(), FailedTo> { let path = path::Path::new(&self.path); self.on_items(|items| {