From 2aa1e7cb46cf5eac3372539aefcef90fe75f9da4 Mon Sep 17 00:00:00 2001
From: davidemazzocchi <davide.mazzocchi@gmail.com>
Date: Tue, 11 Nov 2025 11:16:22 +0100
Subject: [PATCH] doc: update documentation of catalog.persist

---
 01.workspace/heave/src/imp/catalog_persist.rs | 5 +++++
 1 file changed, 5 insertions(+)

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| {